Description

# Auth0 Python Library   [](https://codecov.io/gh/auth0/auth0-python) [](https://deepwiki.com/auth0/auth0-python)  [](https://opensource.org/licenses/MIT) [](https://circleci.com/gh/auth0/auth0-python) [](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fauth0%2Fauth0-python) The Auth0 Python library provides convenient access to the Auth0 APIs from Python. ## Table of Contents - [Installation](#installation) - [Reference](#reference) - [Authentication API](#authentication-api) - [Management API](#management-api) - [Async Client](#async-client) - [Exception Handling](#exception-handling) - [Pagination](#pagination) - [Advanced](#advanced) - [Access Raw Response Data](#access-raw-response-data) - [Retries](#retries) - [Timeouts](#timeouts) - [Custom Client](#custom-client) - [Feedback](#feedback) ## Installation ```sh pip install auth0-python ``` **Requirements:** - Python ≥3.9 (Python 3.8 support has been dropped) ## Reference A full reference for this library is available [here](https://github.com/auth0/auth0-python/blob/master/reference.md). ## Authentication API The Authentication API is used for authentication flows such as obtaining tokens via client credentials, authorization codes, or resource owner password grants: ```python from auth0.authentication import GetToken token_client = GetToken( domain="your-tenant.auth0.com", client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET", ) # Get an access token using client credentials token_response = token_client.client_credentials( audience="https://your-tenant.auth0.com/api/v2/" ) access_token = token_response["access_token"] ``` ## Management API ### Recommended: Using ManagementClient The `ManagementClient` is the recommended way to interact with the Auth0 Management API. It provides a simpler interface using just your Auth0 domain, and supports automatic token management with client credentials: ```python from auth0.management import ManagementClient # With an existing token client = ManagementClient( domain="your-tenant.auth0.com", token="YOUR_TOKEN", ) # Or with client credentials (automatic token acquisition and refresh) client = ManagementClient( domain="your-tenant.auth0.com", client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET", ) ``` For async usage: ```python import asyncio from auth0.management import AsyncManagementClient client = AsyncManagementClient( domain="your-tenant.auth0.com", token="YOUR_TOKEN", ) async def main() -> None: users = await client.users.list() print(users) asyncio.run(main()) ``` ### Using a Token from the Authentication API You can obtain a token using the Authentication API and use it with the Management API client: ```python from auth0.authentication import GetToken from auth0.management import Auth0 domain = "your-tenant.auth0.com" # Get a token using the Authentication API token_client = GetToken( domain=domain, client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET", ) token_response = token_client.client_credentials( audience=f"https://{domain}/api/v2/" ) access_token = token_response["access_token"] # Use the token with the Management API client client = Auth0( base_url=f"https://{domain}/api/v2", token=access_token, ) ``` ### Using the Base Client Alternatively, you can use the `Auth0` client directly with a full base URL: ```python from auth0.management import ActionTrigger, Auth0 client = Auth0( base_url="https://YOUR_TENANT.auth0.com/api/v2", token="YOUR_TOKEN", ) client.actions.create( name="name", supported_triggers=[ ActionTrigger( id="id", ) ], ) ``` ## Async Client The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client). ```python import asyncio from auth0.management import ActionTrigger, AsyncAuth0 client = AsyncAuth0( base_url="https://YOUR_TENANT.auth0.com/api/v2", token="YOUR_TOKEN", ) async def main() -> None: await client.actions.create( name="name", supported_triggers=[ ActionTrigger( id="id", )