Make your first Python SDK call - Clumio

This quickstart makes one read-only SDK call. It uses the users resource because the response is small and easy to inspect.

Prototype note. The package and method names below come from the public SDK repository. This example has not been run against a live Clumio tenant.

Before you start

Python 3.9 or later;
a Clumio API token; and
the hostname for the control plane that issued the token.

Install

python -m pip install 'git+https://github.com/clumio-code/clumio-python-sdk.git@<version>#egg=clumioapi'

Configure the client

import os

from clumioapi import configuration, clumioapi_client

config = configuration.Configuration(
    api_token=os.environ["CLUMIO_API_TOKEN"],
    hostname=os.environ.get("CLUMIO_API_HOST", "us-west-2.api.clumio.com"),
)
client = clumioapi_client.ClumioAPIClient(config=config)

Set CLUMIO_API_TOKEN before running the script. Keep the token out of source control.

Make the call

users = client.users_v2.list_users(limit=10, start=1)
print(users)

If the call succeeds, the SDK returns the same paginated users resource described in List users.

Next steps