Cloudinary Account Provisioning Python SDK

Developer-friendly & type-safe Python SDK specifically catered to leverage cloudinary-account-provisioning API.

Summary

Cloudinary Account Provisioning API: Accounts with provisioning API access can create and manage their product environments, users and user groups using the RESTful Provisioning API.

Provisioning API access is available upon request for accounts on an Enterprise plan.

The API uses Basic Authentication over HTTPS. Your Account API Key and Account API Secret (previously referred to as Provisioning API keys) are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the Cloudinary Console under Settings > Account API Keys.

The Provisioning API has dedicated SDKs for the following languages:

Useful links:

Provisioning API reference (Classic) (includes SDKs for additional languages)

Accounts with Permissions API access can assign roles, made up of system policies, to control what principals (users, groups, and API keys) can do across the Cloudinary account and product environments. For more information about Cloudinary roles and permissions, see the Role-based permissions guide.

Permissions API access is available upon request for accounts on an Enterprise plan.

The API uses Basic Authentication over HTTPS. Your Account API Key and Account API Secret (previously referred to as Provisioning API keys) are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the Cloudinary Console under Settings > Account API Keys.

Important:

Cloudinary's Roles and Permissions Management is now available as a Beta. This is an early stage release, and while it's functional and ready for real-world testing, it's subject to change as we continue refining the experience based on what we learn, including your feedback. During the Beta period, core functionality is considered stable, though some APIs, scopes, or response formats may evolve.

How you can help:

Use Roles and Permissions Management in real projects, prototypes, or tests.
Share feedback, issues, or ideas with our support team.

Thank you for exploring this early release and helping us shape these tools to best meet your needs.

SDK Installation

Tip

To finish publishing your SDK to PyPI you must run your first generation action.

Note

Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

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

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+https://github.com/cloudinary/account-provisioning-python.git

PIP

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

pip install git+https://github.com/cloudinary/account-provisioning-python.git

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 git+https://github.com/cloudinary/account-provisioning-python.git

Shell and script usage with `uv`

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from cloudinary-account-provisioning python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "cloudinary-account-provisioning",
# ]
# ///

from cloudinary_account_provisioning import CldProvisioning

sdk = CldProvisioning(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

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
import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning


with CldProvisioning(
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning

async def main():

    async with CldProvisioning(
        account_id="<id>",
        security=cloudinary_account_provisioning.Security(
            provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
            provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
        ),
    ) as cld_provisioning:

        res = await cld_provisioning.product_environments.list_async(enabled=True, prefix="product")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`provisioning_api_key` `provisioning_api_secret`	http	Custom HTTP	`CLOUDINARY_PROVISIONING_API_KEY` `CLOUDINARY_PROVISIONING_API_SECRET`

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning


with CldProvisioning(
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
    account_id="<id>",
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

AccessKeys

list - Get access keys
generate - Generate an access key
delete_by_name - Delete access key by name
update - Update an access key
delete - Delete access key

BillingUsage

get - Get billing usage information

CustomPolicies

list - Get custom policies
create - Create custom policy
get - Get custom policy
update - Update custom policy
delete - Delete custom policy

EffectivePolicies

list - Get effective policies

Principals

list_roles - Get a principal's roles
update_roles - Assign roles to a principal
inspect - Inspect
inspect_multiple - Inspect multiple

ProductEnvironments

list - Get product environments
create - Create product environment
get - Get product environment
update - Update product environment
delete - Delete product environment

Public

get_catalog - Get system roles and policies catalog
validate_policy - Validate a Cedar policy
get_schema - Get Cedar schema

Roles

list - Get roles
create - Create custom role
get - Get role
update - Update custom role
delete - Delete custom role
list_principals - Get a role's principals
update_principals - Assign principals to a role

SystemPolicies

list - Get system policies

UserGroups

list - Get User Groups
create - Create User Group
get - Get User Group
update - Update User Group
delete - Delete User Group
list_users - Get Users in User Group
add_user - Add User to User Group
remove_user - Remove User from User Group

Users

list - Get users
create - Create user
get - Get user
update - Update user
delete - Delete user
get_groups - Get user groups
list_sub_accounts - Get user sub-accounts

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set account_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like list. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. Global parameters can also be set via environment variable.

Name	Type	Description	Environment
account_id	str	Account ID	CLOUDINARY_ACCOUNT_ID

Example

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning


with CldProvisioning(
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

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:

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning
from cloudinary_account_provisioning.utils import BackoffStrategy, RetryConfig


with CldProvisioning(
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

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:

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning
from cloudinary_account_provisioning.utils import BackoffStrategy, RetryConfig


with CldProvisioning(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

Error Handling

CloudinaryError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`err.message`	`str`	Error message
`err.status_code`	`int`	HTTP response status code eg `404`
`err.headers`	`httpx.Headers`	HTTP response headers
`err.body`	`str`	HTTP body. Can be empty string if no body is returned.
`err.raw_response`	`httpx.Response`	Raw HTTP response
`err.data`		Optional. Some errors may contain structured data. See Error Classes.

Example

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning, models


with CldProvisioning(
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:
    res = None
    try:

        res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

        # Handle response
        print(res)


    except models.CloudinaryError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, models.ErrorResponse):
            print(e.data.error)  # Optional[cloudinary_account_provisioning.Error]

Error Classes

Primary error:

CloudinaryError: The base class for HTTP error responses.

Less common errors (7)

Network errors:

httpx.RequestError: Base class for request errors.
- httpx.ConnectError: HTTP client was unable to make a request to a server.
- httpx.TimeoutException: HTTP request timed out.

Inherit from CloudinaryError:

ErrorResponse: Bad request. Applicable to 26 of 47 methods.*
PermissionsErrorResponse: Applicable to 18 of 47 methods.*
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables	Description
0	`https://{region}.cloudinary.com`	`region`	Regional API endpoints for optimal performance.
1	`https://{host}`	`host`	Custom domains for enterprise deployments.

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

Variable	Parameter	Supported Values	Default	Description
`region`	`region: models.ServerRegion`	- `"api"` - `"api-eu"` - `"api-ap"`	`"api"`	Regional endpoint selection
`host`	`host: str`	str	`"api.cloudinary.com"`	API host domain.

Example

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning


with CldProvisioning(
    server_idx=0,
    region="api-ap",
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

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:

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning


with CldProvisioning(
    server_url="https://api.cloudinary.com",
    account_id="<id>",
    security=cloudinary_account_provisioning.Security(
        provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
        provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
    ),
) as cld_provisioning:

    res = cld_provisioning.product_environments.list(enabled=True, prefix="product")

    # Handle response
    print(res)

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 cloudinary_account_provisioning import CldProvisioning
import httpx

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

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

from cloudinary_account_provisioning import CldProvisioning
from cloudinary_account_provisioning.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 = CldProvisioning(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The CldProvisioning class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

import cloudinary_account_provisioning
from cloudinary_account_provisioning import CldProvisioning
def main():

    with CldProvisioning(
        account_id="<id>",
        security=cloudinary_account_provisioning.Security(
            provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
            provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
        ),
    ) as cld_provisioning:
        # Rest of application here...


# Or when using async:
async def amain():

    async with CldProvisioning(
        account_id="<id>",
        security=cloudinary_account_provisioning.Security(
            provisioning_api_key="CLOUDINARY_PROVISIONING_API_KEY",
            provisioning_api_secret="CLOUDINARY_PROVISIONING_API_SECRET",
        ),
    ) as cld_provisioning:
        # Rest of application here...

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 cloudinary_account_provisioning import CldProvisioning
import logging

logging.basicConfig(level=logging.DEBUG)
s = CldProvisioning(debug_logger=logging.getLogger("cloudinary_account_provisioning"))

You can also enable a default debug logger by setting an environment variable CLOUDINARY_DEBUG to true.

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.

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
.vscode		.vscode
docs		docs
scripts		scripts
src/cloudinary_account_provisioning		src/cloudinary_account_provisioning
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README-PYPI.md		README-PYPI.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
poetry.lock		poetry.lock
poetry.toml		poetry.toml
py.typed		py.typed
pylintrc		pylintrc
pyproject.toml		pyproject.toml

License

cloudinary/account-provisioning-python

Folders and files

Latest commit

History

Repository files navigation

Cloudinary Account Provisioning Python SDK

Summary

Table of Contents

SDK Installation

uv

PIP

Poetry

Shell and script usage with uv

IDE Support

PyCharm

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Global Parameters

Available Globals

Example

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Resource Management

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages

Shell and script usage with `uv`