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:
Useful links:
-
Provisioning API reference (Classic)
For more information, please visit https://support.cloudinary.com.
Java 6 and later.
The cloudinary_java library is available in Maven Central. To use it, add the following dependency to your pom.xml :
<dependency>
<groupId>com.cloudinary.account.provisioning</groupId>
<artifactId>cloudinary-account-provisioning</artifactId>
<version>0.1.0</version>
<scope>compile</scope>
</dependency>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 |
To add a HTTP proxy for the API client, use ClientConfig:
import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import com.cloudinary.account.provisioning.*;
import com.cloudinary.account.provisioning.api.AccessKeysApi;
...
ApiClient apiClient = Configuration.getDefaultApiClient();
// If you don't supply cloudinary url through apiClient.setCloudinaryUrl("Cloudinary account url"> it'll be taken from environment variable
apiClient.setCloudinaryUrl("account://provisioning_key:provisioning_secret@account_id");
AccessKeysApi apiInstance = new AccessKeysApi(apiClient);- AccessKey
- AccessKeyRequest
- AccessKeyUpdateRequest
- AccessKeysResponse
- ApiAccessKey
- CreateUserRequest
- ErrorResponse
- ErrorResponseError
- ProductEnvironment
- ProductEnvironmentRequest
- ProductEnvironmentUpdateRequest
- ProductEnvironmentsResponse
- SuccessResponse
- User
- UserGroup
- UserGroupRequest
- UserGroupSummary
- UserGroupUser
- UserGroupUsersResponse
- UserGroupsResponse
- UserRequest
- UsersResponse
Authentication schemes defined for the API:
- Type: HTTP basic authentication
This Cloudinary Java package is automatically generated by the OpenAPI Generator project:
- API version:
0.1.2- Package version:
0.1.0 - Build date:
2024-11-19T16:44:42.106539Z[Etc/UTC]
- Package version:
- Build package:
org.openapitools.codegen.languages.JavaClientCodegen