Skip to main content

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)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agilicus-1.423.1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agilicus-1.423.1-py3-none-any.whl (6.7 MB view details)

Uploaded Python 3

File details

Details for the file agilicus-1.423.1.tar.gz.

File metadata

  • Download URL: agilicus-1.423.1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.11 Linux/6.12.85+

File hashes

Hashes for agilicus-1.423.1.tar.gz
Algorithm Hash digest
SHA256 00e8243e9cc81021bcb92a3d30a6056ca457c5f33fce677fd9a8cf6f0444aab9
MD5 fa24b81303d7a878b8d05f2d8bfd1bf7
BLAKE2b-256 319fcd3bb5317cddb6a02459dd4ced0c6e8e17c5781d213be496785fb99aa164

See more details on using hashes here.

File details

Details for the file agilicus-1.423.1-py3-none-any.whl.

File metadata

  • Download URL: agilicus-1.423.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.11 Linux/6.12.85+

File hashes

Hashes for agilicus-1.423.1-py3-none-any.whl
Algorithm Hash digest
SHA256 291a9a2ca191069c95538cd9ddd55f4655bf15fbc7502f80e69730444909b77a
MD5 afeece7b1230491c54b3461dbfc23404
BLAKE2b-256 48a1d8940fa6aab99305c2687b0d4d752b49ad32d6a75738b3df2ffe3ee13dbf

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page