Skip to content

README.md

Latest commit

 

History

History
85 lines (58 loc) · 9.61 KB

README.md

File metadata and controls

85 lines (58 loc) · 9.61 KB

SystemPolicies

Overview

Available Operations

  • list - Get system policies

list

Retrieve all system-defined permission policies. Optionally filter the results by scope_type (account or product environment) and/or permission_type (global or content-specific).

Note: If scope_type isn't specified as prodenv, the account-level policies will be returned.

Example Usage

# 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.system_policies.list(permission_type=cloudinary_account_provisioning.PermissionTypeEnum.GLOBAL, scope_type=cloudinary_account_provisioning.ScopeTypeEnum.PRODENV)

    # Handle response
    print(res)

An Async SDK client can also be used to make asynchronous requests by importing it and asyncio.

# Asynchronous Example
import asyncio
import cloudinary_account_provisioning
from cloudinary_account_provisioning import AsyncCldProvisioning

async def main():

    async with AsyncCldProvisioning(
        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.system_policies.list(permission_type=cloudinary_account_provisioning.PermissionTypeEnum.GLOBAL, scope_type=cloudinary_account_provisioning.ScopeTypeEnum.PRODENV)

        # Handle response
        print(res)

asyncio.run(main())

Parameters

Parameter Type Required Description Example
permission_type Optional[models.PermissionTypeEnum] ➖ Specifies whether to retrieve roles whose permissions apply globally across all contexts within the scope (i.e., security settings for the account, or all folders in a product environment), or specifically to designated content instances (i.e., folder with external ID "fg3841spr"). global
scope_type Optional[models.ScopeTypeEnum] ➖ Specifies the level for retrieving policies or roles, either at the account level or within product environments. prodenv
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SystemPoliciesResponse

Errors

Error Type Status Code Content Type
models.PermissionsErrorResponse 401, 403 application/json
models.PermissionsErrorResponse 500 application/json
models.APIError 4XX, 5XX */*