@cloudinary/account-provisioning

Cloudinary 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 Provisioning Key and Provisioning Secret are used for the authentication. These credentials (as well as your ACCOUNT_ID) 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.

The Provisioning API has dedicated SDKs for the following languages:

• JavaScript
• PHP
• Java

Useful links:

• Provisioning API reference (Classic)

API Endpoints

All URIs are relative to https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID

Class	Method	HTTP request	Description
AccessKeysApi	deleteAccessKey	DELETE /sub_accounts/{sub_account_id}/access_keys/{key}	Delete access key
AccessKeysApi	deleteAccessKeyByName	DELETE /sub_accounts/{sub_account_id}/access_keys	Delete access key by name
AccessKeysApi	generateAccessKey	POST /sub_accounts/{sub_account_id}/access_keys	Generate an access key
AccessKeysApi	getAccessKeys	GET /sub_accounts/{sub_account_id}/access_keys	Get access keys
AccessKeysApi	updateAccessKey	PUT /sub_accounts/{sub_account_id}/access_keys/{key}	Update an access key
ProductEnvironmentsApi	createProductEnvironment	POST /sub_accounts	Create product environment
ProductEnvironmentsApi	deleteProductEnvironment	DELETE /sub_accounts/{sub_account_id}	Delete product environment
ProductEnvironmentsApi	getProductEnvironment	GET /sub_accounts/{sub_account_id}	Get product environment
ProductEnvironmentsApi	getProductEnvironments	GET /sub_accounts	Get product environments
ProductEnvironmentsApi	updateProductEnvironment	PUT /sub_accounts/{sub_account_id}	Update product environment
UserGroupsApi	addUserToUserGroup	POST /user_groups/{group_id}/users/{user_id}	Add User to User Group
UserGroupsApi	createUserGroup	POST /user_groups	Create User Group
UserGroupsApi	deleteUserGroup	DELETE /user_groups/{group_id}	Delete User Group
UserGroupsApi	getUserGroup	GET /user_groups/{group_id}	Get User Group
UserGroupsApi	getUserGroups	GET /user_groups	Get User Groups
UserGroupsApi	getUsersInUserGroup	GET /user_groups/{group_id}/users	Get Users in User Group
UserGroupsApi	removeUserFromUserGroup	DELETE /user_groups/{group_id}/users/{user_id}	Remove User from User Group
UserGroupsApi	updateUserGroup	PUT /user_groups/{group_id}	Update User Group
UsersApi	createUser	POST /users	Create user
UsersApi	deleteUser	DELETE /users/{user_id}	Delete user
UsersApi	getUser	GET /users/{user_id}	Get user
UsersApi	getUsers	GET /users	Get users
UsersApi	updateUser	PUT /users/{user_id}	Update user

Models

• AccessKey
• AccessKeyRequest
• AccessKeyUpdateRequest
• AccessKeysResponse
• ApiAccessKey
• CreateUserRequest
• ErrorResponse
• ErrorResponseError
• ProductEnvironment
• ProductEnvironmentRequest
• ProductEnvironmentUpdateRequest
• ProductEnvironmentsResponse
• SuccessResponse
• User
• UserGroup
• UserGroupRequest
• UserGroupSummary
• UserGroupUser
• UserGroupUsersResponse
• UserGroupsResponse
• UserRequest
• UsersResponse

Installation

npm install @cloudinary/account-provisioning

Get Help

If you run into an issue or have a question, you can either:

• Issues related to the SDK: Open a Github issue
• Issues related to your account: Open a support ticket

Additional Resources

• Cloudinary Transformation and REST API References: Comprehensive references, including syntax and examples for all SDKs.
• MediaJams.dev: Bite-size use-case tutorials written by and for Cloudinary Developers
• DevJams: Cloudinary developer podcasts on YouTube.
• Cloudinary Academy: Free self-paced courses, instructor-led virtual courses, and on-site courses.
• Code Explorers and Feature Demos: A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
• Cloudinary Roadmap: Your chance to follow, vote, or suggest what Cloudinary should develop next.
• Cloudinary Facebook Community: Learn from and offer help to other Cloudinary developers.
• Cloudinary Account Registration: Free Cloudinary account registration.
• Cloudinary Website

Licence

Released under the MIT license.