Skip to content

README.md

Latest commit

 

History

History
141 lines (91 loc) · 6.45 KB

README.md

File metadata and controls

141 lines (91 loc) · 6.45 KB

Public

Overview

View shared Permissions system utilities, including the system roles and policies catalog, Cedar policy validation, and the Cedar schema. These endpoints are publicly accessible and don't require authentication.

Available Operations

get_catalog

Retrieves the catalog of predefined system roles and their associated policies.

Example Usage

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",
    ),
) as cld_provisioning:

    res = cld_provisioning.public.get_catalog()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SystemRolesAndPoliciesCatalogResponse

Errors

Error Type Status Code Content Type
models.APIError 4XX, 5XX */*

validate_policy

Validate a Cedar policy

Example Usage

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",
    ),
) as cld_provisioning:

    res = cld_provisioning.public.validate_policy(request={
        "policy": "permit(principal == Cloudinary::APIKy::\"1234\", action == Cloudinary::Action::\"read\", resource is Cloudinary::Folder ) when {resource.ancestor_ids.contains(\"asdfjkl12347890\")} ;",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.ValidateCedarPolicyRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ValidateCedarPolicyResponse

Errors

Error Type Status Code Content Type
models.APIError 4XX, 5XX */*

get_schema

Get Cedar schema

Example Usage

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",
    ),
) as cld_provisioning:

    res = cld_provisioning.public.get_schema()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CedarSchemaResponse

Errors

Error Type Status Code Content Type
models.APIError 4XX, 5XX */*