Agilicus SDK (Python)
The Agilicus Platform API. is defined using OpenAPI 3.0, and may be used from any language. This allows configuration of our Zero-Trust Network Access cloud native platform using REST. You can see the API specification online.
This package provides a Python SDK, class library interfaces for use in accessing individual collections. In addition it provides a command-line-interface (CLI) for interactive use.
Read the class-library documentation online
Samples shows various examples of this code in use.
Generally you may install this from pypi as:
pip install --upgrade agilicus
You may wish to add bash completion by adding this to your ~/.bashrc:
eval "$(_AGILICUS_CLI_COMPLETE=source agilicus-cli)"
Example: List users
The below python code will show the same output as the CLI command:
agilicus-cli --issuer https://auth.dbt.agilicus.cloud list-users
import agilicus
import argparse
import sys
scopes = agilicus.scopes.DEFAULT_SCOPES
parser = argparse.ArgumentParser(description="update-user")
parser.add_argument("--auth-doc", type=str)
parser.add_argument("--issuer", type=str)
parser.add_argument("--email", type=str)
parser.add_argument("--disable-user", type=bool, default=None)
args = parser.parse_args()
if not args.auth_doc and not args.issuer:
print("error: specify either an --auth-doc or --issuer")
sys.exit(1)
if not args.email:
print("error: specify an email to search for a user")
sys.exit(1)
api = agilicus.GetClient(
agilicus_scopes=scopes, issuer=args.issuer, authentication_document=args.auth_doc
)
users = api.users.list_users(org_id=api.default_org_id, email=args.email)
if len(users.users) != 1:
print(f"error: failed to find user with email: {args.email}")
sys.exit(1)
user = users.users[0]
if args.disable_user is not None:
user.enabled = args.disable_user
result = api.users.replace_user(
user.id, user=user, _check_input_type=False, _host_index=0
)
print(result)
Using an existing access token
GetClient obtains a token itself (browser login or an authentication
document). If you already hold an access token, for example from a
browserless OIDC flow, pass it as token and the credential prompt is
skipped:
api = agilicus.GetClient(
token=access_token, api_url="https://api.agilicus.com"
)
The token is used as-is; api.default_org_id is read from its org claim.
1 maintainer
Metadata
1 maintainer
Release files for agilicus 1.438.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| agilicus-1.438.0.tar.gz | 1.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| agilicus-1.438.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.5 MB
Release files / agilicus-1.438.0.tar.gz
| Download URL | agilicus-1.438.0.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
942ab2219cfd3ddd301180a6be7ca00b31cc71840023438219a3d6dd6302390a
|
|
BLAKE2b-256 checksum How to use checksums |
f35eeb3384ced783e82a640093a254865ebf5c8d798cbcfe2772cc513bffe45d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.14 Linux/6.17.8-061708-generic
|
Release files / agilicus-1.438.0-py3-none-any.whl
| Download URL | agilicus-1.438.0-py3-none-any.whl |
|---|---|
| Size | 6.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74407b93c7b049c925ceb92c261a5c883d2b8c7e5e5a6cb3d5df64a55fa0e019
|
|
BLAKE2b-256 checksum How to use checksums |
a699752fbe8d2582bd9b88c410e90ef086eebce4dec194708795adf78e3feb62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.14 Linux/6.17.8-061708-generic
|
