UserGroups

Overview

Available Operations

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

list

Retrieve an array of all user groups in the account.

Learn more about retrieving user groups. https://cloudinary.com/documentation/provisioning_api#get_user_groups

Example Usage: UserGroups

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.user_groups.list(extended_details=True)

    # Handle response
    print(res)

Example Usage: UserGroupsExtendedDetails

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.user_groups.list(extended_details=True)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`extended_details`	Optional[bool]	➖	Whether to only return extended (true) or basic information about the group (false). Default: false.	true
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroupsResponse

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	401, 404, 420, 429	application/json
models.APIError	4XX, 5XX	/

create

Create a new user group for the account.

Learn more about creating user groups. https://cloudinary.com/documentation/provisioning_api#create_user_group

Example Usage

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.user_groups.create(request={
        "name": "Designers",
        "extended_details": False,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.UserGroup

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	400, 401, 403, 404, 409, 420, 429	application/json
models.APIError	4XX, 5XX	/

get

Retrieve a specific user group.

Learn more about retrieving a specific user group. https://cloudinary.com/documentation/provisioning_api#get_user_group

Example Usage: UserGroupDesigners

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.user_groups.get(group_id="7f08f1f1fc910bf1f25274aef11d27", extended_details=True)

    # Handle response
    print(res)

Example Usage: UserGroupDesignersExtendedDetails

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.user_groups.get(group_id="7f08f1f1fc910bf1f25274aef11d27", extended_details=True)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`extended_details`	Optional[bool]	➖	Whether to only return extended (true) or basic information about the group (false). Default: false.	true
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroup

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	401, 404, 420, 429	application/json
models.APIError	4XX, 5XX	/

update

Update the name of a specified user group.

Learn more about updating a specific user group. https://cloudinary.com/documentation/provisioning_api#update_user_group

Example Usage: UserGroupDesignersRequest

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.user_groups.update(group_id="7f08f1f1fc910bf1f25274aef11d27", user_group_request={
        "name": "Designers and Creatives",
    })

    # Handle response
    print(res)

Example Usage: UserGroupUpdate

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.user_groups.update(group_id="7f08f1f1fc910bf1f25274aef11d27", user_group_request={
        "name": "Designers",
        "extended_details": False,
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`user_group_request`	models.UserGroupRequest	✔️	User group details to update.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroup

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	400, 401, 403, 404, 409, 420, 429	application/json
models.APIError	4XX, 5XX	/

delete

Delete a user group with the specified ID.

Learn more about deleting a specific user group. https://cloudinary.com/documentation/provisioning_api#delete_user_group

Example Usage

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.user_groups.delete(group_id="7f08f1f1fc910bf1f25274aef11d27")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SuccessResponse

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	400, 401, 403, 404, 420, 429	application/json
models.APIError	4XX, 5XX	/

list_users

Retrieve the users in the group with the specified ID.

Learn more about retrieving users in a specific user group. https://cloudinary.com/documentation/provisioning_api#get_user_group_users

Example Usage

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.user_groups.list_users(group_id="7f08f1f1fc910bf1f25274aef11d27")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroupUsersResponse

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	401, 404, 420, 429	application/json
models.APIError	4XX, 5XX	/

add_user

Add a user to a group with the specified ID.

Learn more about adding users to a specific user group. https://cloudinary.com/documentation/provisioning_api#add_user_to_group

Example Usage

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.user_groups.add_user(group_id="7f08f1f1fc910bf1f25274aef11d27", user_id="0abed8dfcc039ea05e2a1d494fd442")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`user_id`	str	✔️	The ID of the user.	0abed8dfcc039ea05e2a1d494fd442
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroupUser

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	400, 401, 403, 404, 409, 420, 429	application/json
models.APIError	4XX, 5XX	/

remove_user

Remove a user from a group with the specified ID.

Learn more about removing users from a specific user group. https://cloudinary.com/documentation/provisioning_api#remove_user_from_group

Example Usage

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.user_groups.remove_user(group_id="7f08f1f1fc910bf1f25274aef11d27", user_id="0abed8dfcc039ea05e2a1d494fd442")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`group_id`	str	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27
`user_id`	str	✔️	The ID of the user.	0abed8dfcc039ea05e2a1d494fd442
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UserGroupUsersResponse

Errors

Error Type	Status Code	Content Type
models.ErrorResponse	400, 401, 403, 404, 420, 429	application/json
models.APIError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

UserGroups

Overview

Available Operations

list

Example Usage: UserGroups

Example Usage: UserGroupsExtendedDetails

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage: UserGroupDesigners

Example Usage: UserGroupDesignersExtendedDetails

Parameters

Response

Errors

update

Example Usage: UserGroupDesignersRequest

Example Usage: UserGroupUpdate

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

list_users

Example Usage

Parameters

Response

Errors

add_user

Example Usage

Parameters

Response

Errors

remove_user

Example Usage

Parameters

Response

Errors