The most comprehensive User Management Platform

Summary

Clerk Backend API: The Clerk REST Backend API, meant to be accessed by backend servers.

Versions

When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. 2021-02-05. For more information, please see Clerk API Versions.

Please see https://clerk.com/docs for more information.

More information about the API can be found at https://clerk.com/docs

Table of Contents

• SDK Installation
• IDE Support
• SDK Example Usage
• Available Resources and Operations
• File uploads
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install clerk-backend-api

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add clerk-backend-api

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.email_addresses.get(email_address_id="email_address_id_example")

    if res is not None:
        # handle response
        pass

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from clerk_backend_api import Clerk

async def main():
    async with Clerk(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as s:
        res = await s.email_addresses.get_async(email_address_id="email_address_id_example")

        if res is not None:
            # handle response
            pass

asyncio.run(main())

Available Resources and Operations

Available methods

actor_tokens

• create - Create actor token
• revoke - Revoke actor token

allowlist_blocklist

• list_allowlist_identifiers - List all identifiers on the allow-list
• create_allowlist_identifier - Add identifier to the allow-list
• create_blocklist_identifier - Add identifier to the block-list
• delete_blocklist_identifier - Delete identifier from block-list

allowlist_identifiers

• delete - Delete identifier from allow-list

beta_features

• update_instance_settings - Update instance settings
• update_domain - Update production instance domain ⚠️ Deprecated
• change_production_instance_domain - Update production instance domain

blocklist_identifiers

• list - List all identifiers on the block-list

clients

• list - List all clients ⚠️ Deprecated
• verify - Verify a client
• get - Get a client

domains

• list - List all instance domains
• add - Add a domain
• delete - Delete a satellite domain
• update - Update a domain

email_addresses

• create - Create an email address
• get - Retrieve an email address
• delete - Delete an email address
• update - Update an email address

email_and_sms_templates

• upsert - Update a template for a given type and slug ⚠️ Deprecated

email_sms_templates

• list - List all templates ⚠️ Deprecated
• revert - Revert a template ⚠️ Deprecated
• get - Retrieve a template ⚠️ Deprecated
• toggle_template_delivery - Toggle the delivery by Clerk for a template of a given type and slug ⚠️ Deprecated

instance_settings

• update - Update instance settings
• update_restrictions - Update instance restrictions
• update_organization_settings - Update instance organization settings

invitations

• create - Create an invitation
• list - List all invitations
• revoke - Revokes an invitation

jwks

• get - Retrieve the JSON Web Key Set of the instance

jwt_templates

• list - List all templates
• create - Create a JWT template
• get - Retrieve a template
• update - Update a JWT template
• delete - Delete a Template

miscellaneous

• get_interstitial - Returns the markup for the interstitial page

oauth_applications

• list - Get a list of OAuth applications for an instance
• create - Create an OAuth application
• get - Retrieve an OAuth application by ID
• update - Update an OAuth application
• delete - Delete an OAuth application
• rotate_secret - Rotate the client secret of the given OAuth application

organization_domain

• update - Update an organization domain.

organization_domains

• create - Create a new organization domain.
• list - Get a list of all domains of an organization.
• delete - Remove a domain from an organization.

organization_invitations

• get_all - Get a list of organization invitations for the current instance
• create - Create and send an organization invitation
• list - Get a list of organization invitations
• bulk_create - Bulk create and send organization invitations
• list_pending - Get a list of pending organization invitations ⚠️ Deprecated
• get - Retrieve an organization invitation by ID
• revoke - Revoke a pending organization invitation

organization_memberships

• create - Create a new organization membership
• list - Get a list of all members of an organization
• update - Update an organization membership
• delete - Remove a member from an organization
• update_metadata - Merge and update organization membership metadata
• get_all - Get a list of all organization memberships within an instance.

organizations

• list - Get a list of organizations for an instance
• create - Create an organization
• get - Retrieve an organization by ID or slug
• update - Update an organization
• delete - Delete an organization
• merge_metadata - Merge and update metadata for an organization
• upload_logo - Upload a logo for the organization
• delete_logo - Delete the organization's logo.

phone_numbers

• create - Create a phone number
• get - Retrieve a phone number
• delete - Delete a phone number
• update - Update a phone number

proxy_checks

• verify - Verify the proxy configuration for your domain

redirect_ur_ls

• list - List all redirect URLs

redirect_urls

• create - Create a redirect URL
• get - Retrieve a redirect URL
• delete - Delete a redirect URL

saml_connections

• list - Get a list of SAML Connections for an instance
• create - Create a SAML Connection
• get - Retrieve a SAML Connection by ID
• update - Update a SAML Connection
• delete - Delete a SAML Connection

sessions

• list - List all sessions
• get - Retrieve a session
• revoke - Revoke a session
• verify - Verify a session ⚠️ Deprecated
• create_token_from_template - Create a session token from a jwt template

sign_in_tokens

• create - Create sign-in token
• revoke - Revoke the given sign-in token

sign_ups

• update - Update a sign-up

templates

• preview - Preview changes to a template ⚠️ Deprecated

testing_tokens

• create - Retrieve a new testing token

users

• list - List all users
• create - Create a new user
• count - Count users
• get - Retrieve a user
• update - Update a user
• delete - Delete a user
• ban - Ban a user
• unban - Unban a user
• lock - Lock a user
• unlock - Unlock a user
• set_profile_image - Set user profile image
• delete_profile_image - Delete user profile image
• update_metadata - Merge and update a user's metadata
• get_o_auth_access_token - Retrieve the OAuth access token of a user
• get_organization_memberships - Retrieve all memberships for a user
• get_organization_invitations - Retrieve all invitations for a user
• verify_password - Verify the password of a user
• verify_totp - Verify a TOTP or backup code for a user
• disable_mfa - Disable a user's MFA methods
• delete_backup_codes - Disable all user's Backup codes
• delete_passkey - Delete a user passkey
• delete_web3_wallet - Delete a user web3 wallet
• create_totp - Create a TOTP for a user
• delete_totp - Delete all the user's TOTPs
• delete_external_account - Delete External Account

webhooks

• create_svix_app - Create a Svix app
• delete_svix_app - Delete a Svix app
• generate_svix_auth_url - Create a Svix Dashboard URL

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.users.set_profile_image(user_id="usr_test123", file={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
        "content_type": "<value>",
    })

    if res is not None:
        # handle response
        pass

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

with Clerk() as s:
    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Use the SDK ...

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

with Clerk(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as s:
    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

    # Use the SDK ...

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.SDKError exception, which has the following properties:

Property	Type	Description
.status_code	int	The HTTP status code
.message	str	The error message
.raw_response	httpx.Response	The raw HTTP response
.body	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the verify_async method may raise the following exceptions:

Error Type	Status Code	Content Type
models.ClerkErrors	400, 401, 404	application/json
models.SDKError	4XX, 5XX	*/*

Example

from clerk_backend_api import Clerk, models

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = None
    try:
        res = s.clients.verify(request={
            "token": "jwt_token_example",
        })

        if res is not None:
            # handle response
            pass

    except models.ClerkErrors as e:
        # handle e.data: models.ClerkErrorsData
        raise(e)
    except models.SDKError as e:
        # handle exception
        raise(e)

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from clerk_backend_api import Clerk

with Clerk(
    server_url="https://api.clerk.com/v1",
) as s:
    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

    # Use the SDK ...

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from clerk_backend_api import Clerk
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Clerk(client=http_client)

or you could wrap the client with your own custom logic:

from clerk_backend_api import Clerk
from clerk_backend_api.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Clerk(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
bearer_auth	http	HTTP Bearer

To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:

from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

    # Use the SDK ...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from clerk_backend_api import Clerk
import logging

logging.basicConfig(level=logging.DEBUG)
s = Clerk(debug_logger=logging.getLogger("clerk_backend_api"))

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy