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.
'Product environments' in Cloudinary were previously known as 'sub-accounts'. The Provisioning API endpoints have not changed, and thus all Provisioning API operations relating to product environments are still performed using the
sub_accounts
endpoints, parameters, response keys, etc.
The Provisioning API is accessed using HTTPS to endpoints. By default, the API endpoint uses the following format:
https://api.cloudinary.com/v1_1/provisioning/accounts/:account_id/:action
For example, to get all product environments (sub_accounts) in the account with ID '16a8ff3b-736b-49a6-85c0-03b69d5a357b':
GET https://api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts
The API uses Basic Authentication over HTTPS. Your Cloudinary Account ID, Provisioning Key and Provisioning Secret are used for the authentication. These ID's are located in the Cloudinary Console under Settings > Account > Provisioning API Access, or they can be obtained from the provisioning environment variable available on your Cloudinary Console Dashboard (in the form: CLOUDINARY_ACCOUNT_URL=account://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@<ACCOUNT_ID>
). As with all configuration parameters, you can either set these values globally, or pass them with each call.
You can experiment with returning a list of users in your own Cloudinary account by replacing the PROVISIONING_KEY
, PROVISIONING_SECRET
, and ACCOUNT_ID
in the cURL command below:
curl https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/<ACCOUNT_ID>/sub_accounts
For most actions, request parameters are passed as JSON objects and the response is a JSON snippet. The response includes information about the action that was performed as well as any new relevant data. For example, the response from a request to get all product environments (sub_accounts):
{
"sub_accounts": [
{
"cloud_name": "product1",
"name": "Product1 Application",
"enabled": true,
"id": "abcde1fghij2klmno3pqrst4uvwxy5z",
"api_access_keys": [
{
"key": "123456789012345",
"secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKe"
}
],
"created_at": "2019-03-15T11:44:48Z"
},
{
"cloud_name": "product2",
"name": "Product2 Application",
"enabled": true,
"id": "0aaaaa1bbbbb2ccccc3ddddd4eeeee5f",
"api_access_keys": [
{
"key": "543210987654321",
"secret": "T415i5mYs3cr3TkeYN0tR3a77y0o0"
}
],
"created_at": "2019-04-27T08:00:16Z"
}
]
}
The following sections provide additional details on working with the Provisioning API:
In addition to the base REST API, our client libraries provide an easy to use wrapper for the Provisioning API. Request building and authentication are done automatically, and the JSON response is parsed and returned.
For example, the following Java SDK method gets a list of enabled product environments that have a name starting with 'prod':
account.getSubAccounts(true, null, "prod");
The API returns the status of requests using the HTTP status codes:
- 200 - OK. Successful.
- 400 - Bad request.
- 401 - Authorization required.
- 403 - Not allowed.
- 404 - Not found.
- 409 - Already exists.
- 420 - Max usage rate exceeded.
The API wrapping of Cloudinary's client libraries report errors by raising applicative exception.
In addition, a JSON response with an informative message is returned. For example:
{ "error": { "message": "User not found" } }
As with the Admin API, you can control the number of results returned in a single request by specifying the max_results parameter, and you can use the returned value of next_cursor to view additional results. For details see Pagination in the Admin API Reference.
Manage the product environments (sub-accounts) of your main account:
Return an array of all product environments, or if conditions are specified, return the relevant product environments.
GET /accounts/:account_id/sub_accounts
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.sub_accounts(enabled = nil, ids = [], prefix = nil, options = {})
PHP (cloudinary_php 1.x (legacy)):
subAccounts(bool $enabled = null, array $ids = [], string $prefix = null);
Python (cloudinary 1.x):
cloudinary.provisioning.sub_accounts(enabled=None, ids=None, prefix=None, **options)
Node.js (cloudinary 1.x):
sub_accounts(boolean enabled, string[] ids, string prefix, object options);
Java (cloudinary 1.x):
subAccounts(Boolean enabled, List<String> ids, String prefix, Map options);
.NET (CloudinaryDotNet 1.x):
SubAccounts(ListSubAccountsParams parameters);
cli:
cld provisioning sub_accounts [$enabled] [$ids] [$prefix] [$options]
Parameter |
Type |
Description |
enabled |
Boolean |
Whether to only return enabled product environments (true) or disabled product environments (false). Default: all product environments are returned (both enabled and disabled). |
ids |
Array of Strings |
A list (SDKs wrap as an array) of up to 100 product environment IDs. When provided, other parameters are ignored. |
prefix |
String |
Returns accounts where the name begins with the specified case-insensitive string. |
options |
Object |
See Configuration parameters. |
Return all enabled product environments with a name that begins with 'product':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.sub_accounts(true, [], "product")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->subAccounts(true, null, "product");
Python (cloudinary 1.x):
cloudinary.provisioning.account.sub_accounts(True, prefix = "product")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.sub_accounts(true, null, "product")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.subAccounts(true, null, "product");
.NET (CloudinaryDotNet 1.x):
var listSubAccountsParams = new ListSubAccountsParams{
Enabled = true,
Prefix = "product" };
account.SubAccounts(listSubAccountsParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"enabled": "true",
"prefix": "product"
}' \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts
cli:
cld provisioning sub_accounts enabled=true prefix="product"
{
"sub_accounts": [
{
"cloud_name": "product2",
"name": "Product2 Application",
"enabled": true,
"id": "0aaaaa1bbbbb2ccccc3ddddd4eeeee5f",
"api_access_keys": [
{
"key": "543210987654321",
"secret": "T415i5mYs3cr3TkeYN0tR3a77y0o0"
}
],
"created_at": "2016-03-15T11:44:48Z"
},
{
"cloud_name": "product1",
"name": "Product1 Application",
"enabled": true,
"id": "abcde1fghij2klmno3pqrst4uvwxy5z",
"api_access_keys": [
{
"key": "123456789012345",
"secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKe"
}
],
"created_at": "2016-09-27T08:00:16Z"
}
]
}
Return the specified product environment.
GET /accounts/:account_id/sub_accounts/:sub_account_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.sub_account(sub_account_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
subAccount(string $subAccountId);
Python (cloudinary 1.x):
cloudinary.provisioning.sub_account(sub_account_id, **options)
Node.js (cloudinary 1.x):
sub_account(string sub_account_id, object options);
Java (cloudinary 1.x):
subAccount(String subAccountID, Map options);
.NET (CloudinaryDotNet 1.x):
SubAccount(string subAccountId);
cli:
cld provisioning sub_account $sub_account_id [$options]
Parameter |
Type |
Description |
sub_account_id |
String |
The ID of the product environment to get. |
Return the product environment with the id of '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.sub_account("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->subAccount("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.sub_account("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.sub_account("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.subAccount("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.SubAccount("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning sub_account "7f08f1f1fc910bf1f25274aef11d27"
{
"cloud_name": "product1",
"name": "Product1 Application",
"enabled": true,
"id": "7f08f1f1fc910bf1f25274aef11d27",
"api_access_keys": [
{
"key": "123456789012345",
"secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKe"
}
],
"created_at": "2016-09-27T08:00:16Z"
}
Create a new product environment. Any users that have access to all product environments will also automatically have access to the new product environment.
POST /accounts/:account_id/sub_accounts
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_sub_account(name, cloud_name = nil, custom_attributes = {}, base_account = nil, options = {})
PHP (cloudinary_php 1.x (legacy)):
createSubAccount(string $name, string $cloudName = null, array $customAttributes = null, bool $enabled = null, string $baseAccount = null);
Python (cloudinary 1.x):
cloudinary.provisioning.create_sub_account(name, cloud_name=None, custom_attributes=None, base_account=None, **options)
Node.js (cloudinary 1.x):
create_sub_account(string name, string cloud_name, object custom_attributes, string base_account, object options);
Java (cloudinary 1.x):
createSubAccount(String name, String cloudName, Map customAttributes, String baseAccount, Map options);
.NET (CloudinaryDotNet 1.x):
CreateSubAccount(CreateSubAccountParams parameters);
cli:
cld provisioning create_sub_account $name [$cloud_name] [$custom_attributes] [$base_account] [$options]
Parameter |
Type |
Description |
name |
String |
The display name as shown in the Cloudinary Console. |
Parameter |
Type |
Description |
cloud_name |
String |
A case-insensitive cloud name comprised of alphanumeric and underscore characters. Use with caution - generates an error if the cloud name is not unique across all Cloudinary accounts. Default: a unique cloud name automatically generated by Cloudinary. |
base_sub_account_id |
String |
The ID of another product environment, from which to copy all of the following settings: Size limits, Timed limits, and Flags. The parameter is called base_account in some SDKs. |
custom_attributes |
Object |
Any custom attributes you want to associate with the product environment, as a map/hash of key/value pairs. |
options |
Object |
See Configuration parameters. |
Create a new product environment called 'demo account':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_sub_account("demo account")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->createSubAccount("demo account", null, null, false, null);
Python (cloudinary 1.x):
cloudinary.provisioning.account.create_sub_account("demo account")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.create_sub_account("demo account")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.createSubAccount("demo account", null, ObjectUtils.emptyMap(), null);
.NET (CloudinaryDotNet 1.x):
var createSubAccountParams = new CreateSubAccountParams("demo account");
account.CreateSubAccount(createSubAccountParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"name": "demo account"
}' \
-X POST \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts
cli:
cld provisioning create_sub_account "demo account"
{
"cloud_name": "product3",
"name": "Product3 Application",
"enabled": false,
"id": "555asdf0000zxcvb3456qwerty",
"api_access_keys": [
{
"key": "135792468054321",
"secret": "w4aTi5Y0u6k3YN0773lL1nGyUt0Da8"
}
],
"created_at": "2016-09-27T11:15:35Z"
}
Update the specified details of the product environment.
PUT /accounts/:account_id/sub_accounts/:sub_account_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_sub_account(sub_account_id, name = nil, cloud_name = nil, custom_attributes = nil, enabled = nil, options = {})
PHP (cloudinary_php 1.x (legacy)):
updateSubAccount(string $subAccountId, string $name = null, string $cloudName = null, array $customAttributes = null, bool $enabled = null);
Python (cloudinary 1.x):
cloudinary.provisioning.update_sub_account(sub_account_id, name=None, cloud_name=None, custom_attributes=None, enabled=None, **options)
Node.js (cloudinary 1.x):
update_sub_account(string sub_account_id, string name, string cloud_name, object custom_attributes, boolean enabled, object options);
Java (cloudinary 1.x):
updateSubAccount(String subAccountId, String name, String cloudName, Map customAttributes, Boolean enabled, Map options);
.NET (CloudinaryDotNet 1.x):
UpdateSubAccount(UpdateSubAccountParams parameters);
cli:
cld provisioning update_sub_account $sub_account_id [$name] [$cloud_name] [$custom_attributes] [$enabled] [$options]
Parameter |
Type |
Description |
sub_account_id |
String |
The ID of the product environment to update. |
Parameter |
Type |
Description |
name |
String |
The display name as shown in the Cloudinary Console. |
cloud_name |
String |
A case-insensitive cloud name comprised of alphanumeric and underscore characters. Use with caution - generates an error if the cloud name is not unique across all Cloudinary accounts. Note: Can only be changed for accounts with fewer than 1000 images. |
custom_attributes |
Object |
Any custom attributes you want to associate with the product environment, as a map/hash of key/value pairs. |
enabled |
Boolean |
Whether the product environment is enabled. Default: true |
options |
Object |
See Configuration parameters. |
To disable the product environment with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_sub_account("7f08f1f1fc910bf1f25274aef11d27", nil, nil, nil, false)
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->updateSubAccount("7f08f1f1fc910bf1f25274aef11d27", null, null, null, false);
Python (cloudinary 1.x):
cloudinary.provisioning.update_sub_account("7f08f1f1fc910bf1f25274aef11d27", enabled = False)
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.update_sub_account("7f08f1f1fc910bf1f25274aef11d27", null, null, {}, false)
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.updateSubAccount("7f08f1f1fc910bf1f25274aef11d27", null, null, {ObjectUtils.emptyMap()}, false);
.NET (CloudinaryDotNet 1.x):
var updateSubAccountParams = new UpdateSubAccountParams("7f08f1f1fc910bf1f25274aef11d27"){
Enabled = false };
account.UpdateSubAccount(updateSubAccountParams)
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"enabled": "false"
}' \
-X PUT \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning update_sub_account "7f08f1f1fc910bf1f25274aef11d27" enabled=false
{
"cloud_name": "product1",
"name": "Product1 Application",
"enabled": false,
"id": "7f08f1f1fc910bf1f25274aef11d27",
"api_access_keys": [
{
"key": "123456789012345",
"secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKe"
}
],
"created_at": "2016-09-27T08:00:16Z"
}
Delete the specified product environment. Supported only for accounts with fewer than 1000 images.
DELETE /accounts/:account_id/sub_accounts/:sub_account_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_sub_account(sub_account_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
deleteSubAccount(string $subAccountId);
Python (cloudinary 1.x):
cloudinary.provisioning.delete_sub_account(sub_account_id, **options)
Node.js (cloudinary 1.x):
delete_sub_account(string sub_account_id, object options);
Java (cloudinary 1.x):
deleteSubAccount(String subAccountID, Map options);
.NET (CloudinaryDotNet 1.x):
DeleteSubAccount(string subAccountId);
cli:
cld provisioning delete_sub_account $sub_account_id [$options]
Parameter |
Type |
Description |
sub_account_id |
String |
The ID of the product environment to delete. |
To delete the product environment with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_sub_account("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->deleteSubAccount("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.delete_sub_account("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.delete_sub_account("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.deleteSubAccount("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.DeleteSubAccount("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl \
-X DELETE \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/sub_accounts/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning delete_sub_account "7f08f1f1fc910bf1f25274aef11d27"
Manage the users for your account:
Method |
Description |
GET/accounts/:account_id/users |
Get users |
GET/accounts/:account_id/users/:user_id |
Get user |
POST/accounts/:account_id/users |
Create user |
PUT/accounts/:account_id/users/:user_id |
Update user |
DELETE/accounts/:account_id/users/:user_id |
Delete user |
Returns an array of all users in the account, or if conditions are specified, returns the relevant users.
GET /accounts/:account_id/users
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.users(pending = nil, user_ids = [], prefix = nil, sub_account_id = nil, options = {})
PHP (cloudinary_php 1.x (legacy)):
users(bool $pending = null, array $userIds = [], string $prefix = null, string $subAccountId = null);
Python (cloudinary 1.x):
cloudinary.provisioning.users(user_ids=None, sub_account_id=None, pending=None, prefix=None, **options)
Node.js (cloudinary 1.x):
users(boolean pending, string[]] ids, string prefix, string sub_account_id, object options);
Java (cloudinary 1.x):
users(Boolean pending, List<String> ids, String prefix, String subAccountId, Map options);
.NET (CloudinaryDotNet 1.x):
Users(ListUsersParams parameters);
cli:
cld provisioning users [$user_ids] [$sub_account_id] [$pending] [$prefix] [$options]
Parameter |
Type |
Description |
pending |
Boolean |
Whether to only return pending users. Default: false (all users) |
ids |
Array of Strings |
A list (SDKs wrap as an array) of up to 100 user IDs. When provided, other parameters are ignored. |
prefix |
String |
Returns users where the name begins with the specified case-insensitive string. |
sub_account_id |
String |
Only returns users who have access to the specified account. |
options |
Object |
See Configuration parameters. |
Return all users with a name that begins with 'john':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.users(nil, [], "john")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->users(null, null, "john", null);
Python (cloudinary 1.x):
cloudinary.provisioning.account.users(prefix = "john")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.users(null, null, "john")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.users(null, null, "john", null);
.NET (CloudinaryDotNet 1.x):
var listUsersParams = new ListUsersParams{
Prefix = "john" };
account.Users(listUsersParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"prefix": "john"
}' \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/users
cli:
cld provisioning users prefix="john"
{
"users": [
{
"id": "139147faa12ce11f22cfaffa84b307",
"name": "john_smith",
"role": "media_library_user",
"email": "john_smith@example.com",
"pending": true,
"enabled": true,
"created_at": "2020-01-13T05:16:06Z",
"last_login": "2022-01-11T15:11:04Z",
"all_sub_accounts": true
},
{
"id": "28c84b2aa7924a5e64f949b5403981",
"name": "john_jones",
"role": "master_admin",
"email": "john_jones@example.com",
"pending": true,
"enabled": true,
"created_at": "2019-01-13T05:16:05Z",
"last_login": "2021-11-12T15:11:02Z",
"all_sub_accounts": true
}
]
}
Return the user with the specified ID.
The
user_id
value is not displayed in the Cloudinary Console, but it is returned when
creating a user. You can also retrieve it based on the user's name or email, using the
get users operation to return a user by prefix.
GET /accounts/:account_id/users/:user_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user(user_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
Python (cloudinary 1.x):
cloudinary.provisioning.user(user_id, **options)
Node.js (cloudinary 1.x):
user(string user_id, object options);
Java (cloudinary 1.x):
user(String userID, Map options);
.NET (CloudinaryDotNet 1.x):
cli:
cld provisioning user $user_id [$options]
Parameter |
Type |
Description |
user_id |
String |
The ID of the user to get. |
Return the user with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->user("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.user("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.user("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.user("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.User("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/users/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning user "7f08f1f1fc910bf1f25274aef11d27"
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "foobar",
"role": "master_admin",
"email": "email@domain.com",
"pending": true,
"enabled": true,
"created_at": "2019-09-12T11:53:57Z",
"last_login": "2022-01-11T15:11:04Z",
"all_sub_accounts": false,
"groups": [],
"sub_account_ids": "555asdf0000zxcvb3456qwerty"
}
Create a new, enabled user for the account with the status pending
.
POST /accounts/:account_id/users
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_user(name, email, role, sub_account_ids = [], options = {})
PHP (cloudinary_php 1.x (legacy)):
createUser(string $name, string $email, string $role, array $subAccountIds = []);
Python (cloudinary 1.x):
cloudinary.provisioning.create_user(name, email, role, sub_account_ids=None, **options)
Node.js (cloudinary 1.x):
create_user(string name, string email, string role, string[] sub_account_ids, object options);
Java (cloudinary 1.x):
createUser(String name, String email, String role, List<String> subAccountsIds, Map options);
.NET (CloudinaryDotNet 1.x):
CreateUser(CreateUserParams parameters);
cli:
cld provisioning create_user $name $email $role [$sub_account_ids] [$options]
Parameter |
Type |
Description |
name |
String |
The user's name. |
email |
String |
A unique email address, which serves as the login name and notification address. |
role |
String |
The role to assign. Possible values: master_admin , admin , billing , technical_admin , reports , media_library_admin , media_library_user |
Parameter |
Type |
Description |
sub_account_ids |
Array of Strings |
A comma-separated list (SDKs wrap as an array) of product environment IDs that this user can access. Note: This parameter is ignored if the role is specified as master_admin . Default: all product environments. |
enabled |
Boolean |
Whether the user is enabled. Default: true |
options |
Object |
See Configuration parameters. |
Create a new user named 'John', with an email address of 'john@example.com' and a role of 'technical_admin':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_user("John", "john@example.com", "technical_admin")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->createUser("John", "john@example.com", "technical_admin", null);
Python (cloudinary 1.x):
cloudinary.provisioning.account.create_user("John", "john@example.com", "technical_admin")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.create_user("John", "john@example.com", "technical_admin")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.createUser("John", "john@example.com", "technical_admin", null);
.NET (CloudinaryDotNet 1.x):
var createUserParams = new CreateUserParams("John", "john@example.com", "technical_admin");
account.CreateUser(createUserParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"name": "John",
"email": "john@example.com",
"role": "technical_admin"
}' \
-X POST \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/users
cli:
cld provisioning create_user "John" "john@example.com" "technical_admin"
{
"id": "0abed8dfcc039ea05e2a1d494fd442",
"name": "John",
"role": "technical_admin",
"email": "john@example.com",
"pending": true,
"enabled": true,
"created_at": "2020-09-03T13:33:25Z",
"all_sub_accounts": true,
"groups": []
}
Update the details of a specified user.
PUT /accounts/:account_id/sub_accounts/:user_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_user(user_id, name = nil, email = nil, role = nil, sub_account_ids = nil, options = {})
PHP (cloudinary_php 1.x (legacy)):
updateUser(string $userId, string $name, string $email, string $role, array $subAccountIds = []);
Python (cloudinary 1.x):
cloudinary.provisioning.update_user(user_id, name=None, email=None, role=None, sub_account_ids=None, **options)
Node.js (cloudinary 1.x):
update_user(string user_id, string name, string email, string role, string[] sub_account_ids, object options);
Java (cloudinary 1.x):
updateUser(String userId, String name, String email, String role, List<String> subAccountsIds, Map options);
.NET (CloudinaryDotNet 1.x):
UpdateUser(UpdateUserParams parameters);
cli:
cld provisioning update_user $user_id [$name] [$email] [$role] [$sub_account_ids] [$options]
Parameter |
Type |
Description |
user_id |
String |
The ID of the user to update. |
Parameter |
Type |
Description |
name |
String |
The user's name. |
email |
String |
A unique email address, which serves as the login name and notification address. |
role |
String |
The role to assign. Possible values: master_admin , admin , billing , technical_admin , reports , media_library_admin , media_library_user |
sub_account_ids |
String |
A comma-separated list (SDKs wrap as an array) of product environment IDs that this user can access. Note: This parameter is ignored if the role is specified as master_admin . |
enabled |
Boolean |
Whether the user is enabled. |
options |
Object |
See Configuration parameters. |
To update the role of a user with id '7f08f1f1fc910bf1f25274aef11d27' to 'admin':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_user("7f08f1f1fc910bf1f25274aef11d27", nil, nil, "admin")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->updateUser("7f08f1f1fc910bf1f25274aef11d27", null, null, "admin", null);
Python (cloudinary 1.x):
cloudinary.provisioning.account.update_user("7f08f1f1fc910bf1f25274aef11d27", role = "admin")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.update_user("7f08f1f1fc910bf1f25274aef11d27", null, null, "admin")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.updateUser("7f08f1f1fc910bf1f25274aef11d27", null, null, "admin", null);
.NET (CloudinaryDotNet 1.x):
var updateUserParams = new UpdateUserParams("7f08f1f1fc910bf1f25274aef11d27"){
Role = "admin" };
account.UpdateUser(updateUserParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"role": "admin"
}' \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/users/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning update_user "7f08f1f1fc910bf1f25274aef11d27" role="admin"
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "John",
"role": "admin",
"email": "john@example.com",
"pending": true,
"enabled": true,
"created_at": "2019-09-12T11:53:57Z",
"all_sub_accounts": false,
"groups": [],
"sub_account_ids": "555asdf0000zxcvb3456qwerty"
}
Delete a user with the specified ID.
DELETE /accounts/:account_id/users/:user_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_user(user_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
deleteUser(string $userId);
Python (cloudinary 1.x):
cloudinary.provisioning.delete_user(user_id, **options)
Node.js (cloudinary 1.x):
delete_user(string user_id, object options);
Java (cloudinary 1.x):
deleteUser(String userId, Map options);
.NET (CloudinaryDotNet 1.x):
DeleteUser(string userId);
cli:
cld provisioning delete_user $user_id [$options]
Parameter |
Type |
Description |
user_id |
String |
The ID of the user to delete. |
Delete the user with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_user("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->deleteUser("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.delete_user("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.delete_user("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.deleteUser("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.DeleteUser("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl \
-X DELETE \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/users/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning delete_user "7f08f1f1fc910bf1f25274aef11d27"
Manage the groups for the users in your account:
Return an array of all user groups in the account.
GET /accounts/:account_id/user_groups
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_groups(options = {})
PHP (cloudinary_php 1.x (legacy)):
Python (cloudinary 1.x):
cloudinary.provisioning.user_groups(**options)
Node.js (cloudinary 1.x):
user_groups(object options);
.NET (CloudinaryDotNet 1.x):
cli:
cld provisioning user_groups [$options]
Return all user groups:
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_groups()
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->userGroups();
Python (cloudinary 1.x):
cloudinary.provisioning.account.user_groups()
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.user_groups()
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
.NET (CloudinaryDotNet 1.x):
curl:
curl https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups
cli:
cld provisioning user_groups
{
"user_groups": [
{
"id": "63a12e42952d888d9cabe7fb38888885",
"name": "user_group_1"
},
{
"id": "1cc3808888154263ac1e5eb2e5c52d61",
"name": "user_group_1"
}
]
}
Return a user group with the specified ID.
GET /accounts/:account_id/user_groups/:group_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_group(group_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
userGroup(string $groupId);
Python (cloudinary 1.x):
cloudinary.provisioning.user_group(user_group_id, **options)
Node.js (cloudinary 1.x):
user_group(string group_id, object options);
Java (cloudinary 1.x):
userGroup(String groupId, Map options);
.NET (CloudinaryDotNet 1.x):
UserGroup(string groupId);
cli:
cld provisioning user_group $user_group_id [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group to get. |
Return the user group with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_group("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->userGroup("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.user_group("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.user_group("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.userGroup("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.UserGroup("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning user_group "7f08f1f1fc910bf1f25274aef11d27"
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "user_group_1"
}
Return the users in the group with the specified ID.
GET /accounts/:account_id/user_groups/:group_id/users
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_group_users(group_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
userGroupUsers(string $groupId);
Python (cloudinary 1.x):
cloudinary.provisioning.user_group_users(user_group_id, **options)
Node.js (cloudinary 1.x):
user_group_users(string group_id, object options);
Java (cloudinary 1.x):
userGroupUsers(String groupId, Map options);
.NET (CloudinaryDotNet 1.x):
UsersGroupUsers(string groupId);
cli:
cld provisioning user_group_users $user_group_id [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group. |
Return the users in the group with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.user_group_users("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->userGroupUsers("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.user_group_users("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.user_group_users("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.userGroupUsers("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.UsersGroupUsers("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27/users
cli:
cld provisioning user_group_users "7f08f1f1fc910bf1f25274aef11d27"
{
"users": [
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "John",
"email": "john@example.com"
}
]
}
Create a new user group for the account.
POST /accounts/:account_id/user_groups
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_user_group(name, options = {})
PHP (cloudinary_php 1.x (legacy)):
createUserGroup(string $name);
Python (cloudinary 1.x):
cloudinary.provisioning.create_user_group(name, **options)
Node.js (cloudinary 1.x):
create_user_group(string name, object options);
Java (cloudinary 1.x):
createUserGroup(String name, Map options);
.NET (CloudinaryDotNet 1.x):
CreateUserGroup(CreateUserGroupParams parameters);
cli:
cld provisioning create_user_group $name [$options]
Parameter |
Type |
Description |
name |
String |
The name for the user group. |
Create a new user group named 'Designers':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.create_user_group("Designers")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->createUserGroup("Designers");
Python (cloudinary 1.x):
cloudinary.provisioning.account.create_user_group("Designers")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.create_user_group("Designers")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.createUserGroup("Designers");
.NET (CloudinaryDotNet 1.x):
account.CreateUserGroup("Designers");
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"name": "Designers"
}' \
-X POST \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups
cli:
cld provisioning create_user_group "Designers"
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "Designers"
}
Add a user to a group with the specified ID.
POST /accounts/:account_id/user_groups/:group_id/users/:user_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.add_user_to_group(group_id, user_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
addUserToGroup(string $groupId, string $userId);
Python (cloudinary 1.x):
cloudinary.provisioning.add_user_to_group(user_group_id, user_id, **options)
Node.js (cloudinary 1.x):
add_user_to_group(string group_id, string user_id, object options);
Java (cloudinary 1.x):
addUserToGroup(String groupId, String userId, Map options);
.NET (CloudinaryDotNet 1.x):
AddUserToGroup(string groupId, string userId);
cli:
cld provisioning add_user_to_group $user_group_id $user_id [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group. |
user_id |
String |
The ID of the user. |
Add the user with id '230df1d1fa913bf1f35e74a1f41e25' to the group with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.add_user_to_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->addUserToGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
Python (cloudinary 1.x):
cloudinary.provisioning.account.add_user_to_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.add_user_to_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.addUserToGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
.NET (CloudinaryDotNet 1.x):
account.AddUserToGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
curl:
curl \
-X POST \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27/users/230df1d1fa913bf1f35e74a1f41e25
cli:
cld provisioning add_user_to_group "7f08f1f1fc910bf1f25274aef11d27" "230df1d1fa913bf1f35e74a1f41e25"
{
"users": [
{
"id": "230df1d1fa913bf1f35e74a1f41e25",
"name": "John",
"email": "john@example.com"
}
]
}
Update the name of a specified user group.
PUT /accounts/:account_id/user_groups/:group_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_user_group(group_id, name, options = {})
PHP (cloudinary_php 1.x (legacy)):
updateUserGroup(string $groupId, string $name);
Python (cloudinary 1.x):
cloudinary.provisioning.update_user_group(group_id, name, **options)
Node.js (cloudinary 1.x):
update_user_group(string group_id, string name, object options);
Java (cloudinary 1.x):
updateUserGroup(String groupId, String name, Map options);
.NET (CloudinaryDotNet 1.x):
UpdateUserGroup(UpdateUserGroupParams parameters);
cli:
cld provisioning update_user_group $group_id $name [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group to update. |
name |
String |
The name for the user group. |
To update the name of a group with id '7f08f1f1fc910bf1f25274aef11d27' to 'Designers':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.update_user_group("7f08f1f1fc910bf1f25274aef11d27", "Designers")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->updateUserGroup("7f08f1f1fc910bf1f25274aef11d27", "Designers");
Python (cloudinary 1.x):
cloudinary.provisioning.account.update_user_group("7f08f1f1fc910bf1f25274aef11d27", "Designers")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.update_user_group("7f08f1f1fc910bf1f25274aef11d27", "Designers")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.updateUserGroup("7f08f1f1fc910bf1f25274aef11d27", "Designers");
.NET (CloudinaryDotNet 1.x):
var updateUserGroupParams = new UpdateUserGroupParams("7f08f1f1fc910bf1f25274aef11d27", "Designers");
account.UpdateUserGroup(updateUserGroupParams);
curl:
curl \
-H "Content-Type: application/json" \
-d '{
"name": "Designers"
}' \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning update_user_group "7f08f1f1fc910bf1f25274aef11d27" "Designers"
{
"id": "7f08f1f1fc910bf1f25274aef11d27",
"name": "Designers"
}
Delete a user group with the specified ID.
DELETE /accounts/:account_id/user_groups/:group_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_user_group(group_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
deleteUserGroup(string $groupId);
Python (cloudinary 1.x):
cloudinary.provisioning.delete_user_group(group_id, **options)
Node.js (cloudinary 1.x):
delete_user_group(string group_id, object options);
Java (cloudinary 1.x):
deleteUserGroup(String groupId, Map options);
.NET (CloudinaryDotNet 1.x):
DeleteUserGroup(string groupId);
cli:
cld provisioning delete_user_group $group_id [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group to delete. |
Delete the user group with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.delete_user_group("7f08f1f1fc910bf1f25274aef11d27")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->deleteUserGroup("7f08f1f1fc910bf1f25274aef11d27");
Python (cloudinary 1.x):
cloudinary.provisioning.account.delete_user_group("7f08f1f1fc910bf1f25274aef11d27")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.delete_user_group("7f08f1f1fc910bf1f25274aef11d27")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.deleteUserGroup("7f08f1f1fc910bf1f25274aef11d27");
.NET (CloudinaryDotNet 1.x):
account.DeleteUserGroup("7f08f1f1fc910bf1f25274aef11d27");
curl:
curl \
-X DELETE \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27
cli:
cld provisioning delete_user_group "7f08f1f1fc910bf1f25274aef11d27"
Remove a user from a group with the specified ID.
DELETE /accounts/:account_id/user_groups/:group_id/users/:user_id
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.remove_user_from_group(group_id, user_id, options = {})
PHP (cloudinary_php 1.x (legacy)):
removeUserFromGroup(string $groupId, string $userId);
Python (cloudinary 1.x):
cloudinary.provisioning.remove_user_from_group(group_id, user_id, **options)
Node.js (cloudinary 1.x):
remove_user_from_group(string group_id, string user_id, object options);
Java (cloudinary 1.x):
removeUserFromGroup(String groupId, String userId, Map options);
.NET (CloudinaryDotNet 1.x):
RemoveUserFromGroup(string groupId, string userId);
cli:
cld provisioning remove_user_from_group $group_id $user_id [$options]
Parameter |
Type |
Description |
group_id |
String |
The ID of the user group. |
user_id |
String |
The ID of the user. |
Remove the user with id '230df1d1fa913bf1f35e74a1f41e25' from the group with id '7f08f1f1fc910bf1f25274aef11d27':
Ruby (cloudinary 1.x):
Cloudinary::AccountApi.Cloudinary::AccountApi.remove_user_from_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
PHP (cloudinary_php 1.x (legacy)):
$account = new \Cloudinary\Api\Provisioning\AccountApi();
$account->removeUserFromGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
Python (cloudinary 1.x):
cloudinary.provisioning.account.remove_user_from_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
Node.js (cloudinary 1.x):
cloudinary.provisioning.account.remove_user_from_group("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25")
.then((response) => { console.log(response); })
.catch((err) => { console.log(err); });
Java (cloudinary 1.x):
account.removeUserFromGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
.NET (CloudinaryDotNet 1.x):
account.RemoveUserFromGroup("7f08f1f1fc910bf1f25274aef11d27", "230df1d1fa913bf1f35e74a1f41e25");
curl:
curl \
-X DELETE \
https://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@api.cloudinary.com/v1_1/provisioning/accounts/16a8ff3b-736b-49a6-85c0-03b69d5a357b/user_groups/7f08f1f1fc910bf1f25274aef11d27/users/230df1d1fa913bf1f35e74a1f41e25
cli:
cld provisioning remove_user_from_group "7f08f1f1fc910bf1f25274aef11d27" "230df1d1fa913bf1f35e74a1f41e25"