{"id":48866796,"url":"https://github.com/cloudinary/account-provisioning-java","last_synced_at":"2026-04-15T19:02:29.383Z","repository":{"id":349585958,"uuid":"718504617","full_name":"cloudinary/account-provisioning-java","owner":"cloudinary","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-06T17:55:29.000Z","size":426,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-04-06T18:07:56.968Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudinary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-11-14T08:11:23.000Z","updated_at":"2026-04-06T17:54:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/cloudinary/account-provisioning-java","commit_stats":null,"previous_names":["cloudinary/account-provisioning-java"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/cloudinary/account-provisioning-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Faccount-provisioning-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Faccount-provisioning-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Faccount-provisioning-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Faccount-provisioning-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudinary","download_url":"https://codeload.github.com/cloudinary/account-provisioning-java/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Faccount-provisioning-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31855432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-15T19:02:28.197Z","updated_at":"2026-04-15T19:02:29.370Z","avatar_url":"https://github.com/cloudinary.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudinary Account Provisioning Java SDK\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.cloudinary.account.provisioning/cloudinary-account-provisioning.svg)](https://central.sonatype.com/artifact/com.cloudinary.account.provisioning/cloudinary-account-provisioning)\n[![License](https://img.shields.io/github/license/cloudinary/account-provisioning-java.svg)](https://github.com/cloudinary/account-provisioning-java/blob/main/LICENSE)\n\nDeveloper-friendly \u0026 type-safe Java SDK for the [Cloudinary Account Provisioning](https://cloudinary.com/documentation/provisioning_api_1) and Permissions APIs.\n\n\u003c!-- Start Summary [summary] --\u003e\n## Summary\n\nCloudinary Account Provisioning API: Accounts with provisioning API access can create and manage their **product environments**, **users** and **user groups** using the RESTful Provisioning API.\n\nProvisioning API access is available [upon request](https://cloudinary.com/contact?plan=enterprise) for accounts on an [Enterprise plan](https://cloudinary.com/pricing#pricing-enterprise).\n\nThe API uses **Basic Authentication** over HTTPS. Your **Account API Key** and **Account API Secret** (previously referred to as **Provisioning API keys**) are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the [Cloudinary Console](https://console.cloudinary.com/pm) under **Settings \u003e Account API Keys**.\n\nThe Provisioning API has dedicated SDKs for the following languages:\n\n* [JavaScript](https://github.com/cloudinary/account-provisioning-js)\n* [PHP](https://github.com/cloudinary/account-provisioning-php)\n* [Java](https://github.com/cloudinary/account-provisioning-java)\n\nUseful links:\n* [Provisioning API reference (Classic)](https://cloudinary.com/documentation/provisioning_api_1) (includes SDKs for additional languages)\n\nAccounts with Permissions API access can assign roles, made up of system policies, to control what principals (users, groups, and API keys) can do across the Cloudinary account and product environments. For more information about Cloudinary roles and permissions, see the [Role-based permissions](permissions_overview) guide.\n\nPermissions API access is available [upon request](https://cloudinary.com/contact?plan=enterprise) for accounts on an [Enterprise plan](https://cloudinary.com/pricing#pricing-enterprise).\n\nThe API uses **Basic Authentication** over HTTPS. Your **Account API Key** and **Account API Secret** (previously referred to as **Provisioning API keys**) are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the [Cloudinary Console](https://console.cloudinary.com/app/settings/account-api-keys) under **Settings \u003e Account API Keys**.\n\n_**Important:**_\n\n_Cloudinary's **Roles and Permissions Management** is now available as a **Beta**. This is an early stage release, and while it's functional and ready for real-world testing, it's subject to change as we continue refining the experience based on what we learn, including your feedback.\nDuring the Beta period, core functionality is considered stable, though some APIs, scopes, or response formats may evolve._\n\n_**How you can help:**_\n\n* _Use Roles and Permissions Management in real projects, prototypes, or tests._\n* _Share feedback, issues, or ideas with our support team._\n\n_Thank you for exploring this early release and helping us shape these tools to best meet your needs._\n\u003c!-- End Summary [summary] --\u003e\n\n\u003c!-- Start Table of Contents [toc] --\u003e\n## Table of Contents\n\u003c!-- $toc-max-depth=2 --\u003e\n* [Cloudinary Account Provisioning Java SDK](#cloudinary-account-provisioning-java-sdk)\n  * [SDK Installation](#sdk-installation)\n  * [SDK Example Usage](#sdk-example-usage)\n  * [Asynchronous Support](#asynchronous-support)\n  * [Authentication](#authentication)\n  * [Available Resources and Operations](#available-resources-and-operations)\n  * [Global Parameters](#global-parameters)\n  * [Error Handling](#error-handling)\n  * [Server Selection](#server-selection)\n  * [Custom HTTP Client](#custom-http-client)\n  * [Debugging](#debugging)\n  * [Jackson Configuration](#jackson-configuration)\n* [Development](#development)\n  * [Maturity](#maturity)\n  * [Contributions](#contributions)\n\n\u003c!-- End Table of Contents [toc] --\u003e\n\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\n### Getting started\n\nJDK 11 or later is required.\n\nThe samples below show how a published SDK artifact is used:\n\nGradle:\n```groovy\nimplementation 'com.cloudinary.account.provisioning:cloudinary-account-provisioning:0.2.0'\n```\n\nMaven:\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.cloudinary.account.provisioning\u003c/groupId\u003e\n    \u003cartifactId\u003ecloudinary-account-provisioning\u003c/artifactId\u003e\n    \u003cversion\u003e0.2.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### How to build\nAfter cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.\n\nIf you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):\n\nOn *nix:\n```bash\n./gradlew publishToMavenLocal -Pskip.signing\n```\nOn Windows:\n```bash\ngradlew.bat publishToMavenLocal -Pskip.signing\n```\n\u003c!-- End SDK Installation [installation] --\u003e\n\n\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        if (res.productEnvironmentsResponse().isPresent()) {\n            System.out.println(res.productEnvironmentsResponse().get());\n        }\n    }\n}\n```\n#### Asynchronous Call\nAn asynchronous SDK client is also available that returns a [`CompletableFuture\u003cT\u003e`][comp-fut]. See [Asynchronous Support](#asynchronous-support) for more details on async benefits and reactive library integration.\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.AsyncCldProvisioning;\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.async.GetProductEnvironmentsResponse;\nimport java.util.concurrent.CompletableFuture;\n\npublic class Application {\n\n    public static void main(String[] args) {\n\n        AsyncCldProvisioning sdk = CldProvisioning.builder()\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build()\n            .async();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        CompletableFuture\u003cGetProductEnvironmentsResponse\u003e resFut = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        resFut.thenAccept(res -\u003e {\n            if (res.productEnvironmentsResponse().isPresent()) {\n                System.out.println(res.productEnvironmentsResponse().get());\n            }\n        });\n    }\n}\n```\n\n[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Asynchronous Support [async-support] --\u003e\n## Asynchronous Support\n\nThe SDK provides comprehensive asynchronous support using Java's [`CompletableFuture\u003cT\u003e`][comp-fut] and [Reactive Streams `Publisher\u003cT\u003e`][reactive-streams] APIs. This design makes no assumptions about your choice of reactive toolkit, allowing seamless integration with any reactive library.\n\n\u003cdetails\u003e\n\u003csummary\u003eWhy Use Async?\u003c/summary\u003e\n\nAsynchronous operations provide several key benefits:\n\n- **Non-blocking I/O**: Your threads stay free for other work while operations are in flight\n- **Better resource utilization**: Handle more concurrent operations with fewer threads\n- **Improved scalability**: Build highly responsive applications that can handle thousands of concurrent requests\n- **Reactive integration**: Works seamlessly with reactive streams and backpressure handling\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eReactive Library Integration\u003c/summary\u003e\n\nThe SDK returns [Reactive Streams `Publisher\u003cT\u003e`][reactive-streams] instances for operations dealing with streams involving multiple I/O interactions. We use Reactive Streams instead of JDK Flow API to provide broader compatibility with the reactive ecosystem, as most reactive libraries natively support Reactive Streams.\n\n**Why Reactive Streams over JDK Flow?**\n- **Broader ecosystem compatibility**: Most reactive libraries (Project Reactor, RxJava, Akka Streams, etc.) natively support Reactive Streams\n- **Industry standard**: Reactive Streams is the de facto standard for reactive programming in Java\n- **Better interoperability**: Seamless integration without additional adapters for most use cases\n\n**Integration with Popular Libraries:**\n- **Project Reactor**: Use `Flux.from(publisher)` to convert to Reactor types\n- **RxJava**: Use `Flowable.fromPublisher(publisher)` for RxJava integration\n- **Akka Streams**: Use `Source.fromPublisher(publisher)` for Akka Streams integration\n- **Vert.x**: Use `ReadStream.fromPublisher(vertx, publisher)` for Vert.x reactive streams\n- **Mutiny**: Use `Multi.createFrom().publisher(publisher)` for Quarkus Mutiny integration\n\n**For JDK Flow API Integration:**\nIf you need JDK Flow API compatibility (e.g., for Quarkus/Mutiny 2), you can use adapters:\n```java\n// Convert Reactive Streams Publisher to Flow Publisher\nFlow.Publisher\u003cT\u003e flowPublisher = FlowAdapters.toFlowPublisher(reactiveStreamsPublisher);\n\n// Convert Flow Publisher to Reactive Streams Publisher\nPublisher\u003cT\u003e reactiveStreamsPublisher = FlowAdapters.toPublisher(flowPublisher);\n```\n\nFor standard single-response operations, the SDK returns `CompletableFuture\u003cT\u003e` for straightforward async execution.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eSupported Operations\u003c/summary\u003e\n\nAsync support is available for:\n\n- **[Server-sent Events](#server-sent-event-streaming)**: Stream real-time events with Reactive Streams `Publisher\u003cT\u003e`\n- **[JSONL Streaming](#jsonl-streaming)**: Process streaming JSON lines asynchronously\n- **[Pagination](#pagination)**: Iterate through paginated results using `callAsPublisher()` and `callAsPublisherUnwrapped()`\n- **[File Uploads](#file-uploads)**: Upload files asynchronously with progress tracking\n- **[File Downloads](#file-downloads)**: Download files asynchronously with streaming support\n- **[Standard Operations](#example)**: All regular API calls return `CompletableFuture\u003cT\u003e` for async execution\n\n\u003c/details\u003e\n\n[comp-fut]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\n[reactive-streams]: https://www.reactive-streams.org/\n\u003c!-- End Asynchronous Support [async-support] --\u003e\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name                                             | Type | Scheme      | Environment Variable                                                       |\n| ------------------------------------------------ | ---- | ----------- | -------------------------------------------------------------------------- |\n| `provisioningApiKey`\u003cbr/\u003e`provisioningApiSecret` | http | Custom HTTP | `CLOUDINARY_PROVISIONING_API_KEY`\u003cbr/\u003e`CLOUDINARY_PROVISIONING_API_SECRET` |\n\nYou can set the security parameters through the `security` builder method when initializing the SDK client instance. For example:\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n                .accountId(\"\u003cid\u003e\")\n            .build();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        if (res.productEnvironmentsResponse().isPresent()) {\n            System.out.println(res.productEnvironmentsResponse().get());\n        }\n    }\n}\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n\u003cdetails open\u003e\n\u003csummary\u003eAvailable methods\u003c/summary\u003e\n\n### [AccessKeys](docs/sdks/accesskeys/README.md)\n\n* [list](docs/sdks/accesskeys/README.md#list) - Get access keys\n* [generate](docs/sdks/accesskeys/README.md#generate) - Generate an access key\n* [deleteByName](docs/sdks/accesskeys/README.md#deletebyname) - Delete access key by name\n* [update](docs/sdks/accesskeys/README.md#update) - Update an access key\n* [delete](docs/sdks/accesskeys/README.md#delete) - Delete access key\n\n### [BillingUsage](docs/sdks/billingusage/README.md)\n\n* [get](docs/sdks/billingusage/README.md#get) - Get billing usage information\n\n### [CustomPolicies](docs/sdks/custompolicies/README.md)\n\n* [list](docs/sdks/custompolicies/README.md#list) - Get custom policies\n* [create](docs/sdks/custompolicies/README.md#create) - Create custom policy\n* [get](docs/sdks/custompolicies/README.md#get) - Get custom policy\n* [update](docs/sdks/custompolicies/README.md#update) - Update custom policy\n* [delete](docs/sdks/custompolicies/README.md#delete) - Delete custom policy\n\n### [EffectivePolicies](docs/sdks/effectivepolicies/README.md)\n\n* [list](docs/sdks/effectivepolicies/README.md#list) - Get effective policies\n\n### [Principals](docs/sdks/principals/README.md)\n\n* [listRoles](docs/sdks/principals/README.md#listroles) - Get a principal's roles\n* [updateRoles](docs/sdks/principals/README.md#updateroles) - Assign roles to a principal\n* [inspect](docs/sdks/principals/README.md#inspect) - Inspect\n* [inspectMultiple](docs/sdks/principals/README.md#inspectmultiple) - Inspect multiple\n\n### [ProductEnvironments](docs/sdks/productenvironments/README.md)\n\n* [list](docs/sdks/productenvironments/README.md#list) - Get product environments\n* [create](docs/sdks/productenvironments/README.md#create) - Create product environment\n* [get](docs/sdks/productenvironments/README.md#get) - Get product environment\n* [update](docs/sdks/productenvironments/README.md#update) - Update product environment\n* [delete](docs/sdks/productenvironments/README.md#delete) - Delete product environment\n\n### [Public](docs/sdks/public/README.md)\n\n* [getCatalog](docs/sdks/public/README.md#getcatalog) - Get system roles and policies catalog\n* [validatePolicy](docs/sdks/public/README.md#validatepolicy) - Validate a Cedar policy\n* [getSchema](docs/sdks/public/README.md#getschema) - Get Cedar schema\n\n### [Roles](docs/sdks/roles/README.md)\n\n* [list](docs/sdks/roles/README.md#list) - Get roles\n* [create](docs/sdks/roles/README.md#create) - Create custom role\n* [get](docs/sdks/roles/README.md#get) - Get role\n* [update](docs/sdks/roles/README.md#update) - Update custom role\n* [delete](docs/sdks/roles/README.md#delete) - Delete custom role\n* [listPrincipals](docs/sdks/roles/README.md#listprincipals) - Get a role's principals\n* [updatePrincipals](docs/sdks/roles/README.md#updateprincipals) - Assign principals to a role\n\n### [SystemPolicies](docs/sdks/systempolicies/README.md)\n\n* [list](docs/sdks/systempolicies/README.md#list) - Get system policies\n\n### [UserGroups](docs/sdks/usergroups/README.md)\n\n* [list](docs/sdks/usergroups/README.md#list) - Get User Groups\n* [create](docs/sdks/usergroups/README.md#create) - Create User Group\n* [get](docs/sdks/usergroups/README.md#get) - Get User Group\n* [update](docs/sdks/usergroups/README.md#update) - Update User Group\n* [delete](docs/sdks/usergroups/README.md#delete) - Delete User Group\n* [listUsers](docs/sdks/usergroups/README.md#listusers) - Get Users in User Group\n* [addUser](docs/sdks/usergroups/README.md#adduser) - Add User to User Group\n* [removeUser](docs/sdks/usergroups/README.md#removeuser) - Remove User from User Group\n\n### [Users](docs/sdks/users/README.md)\n\n* [list](docs/sdks/users/README.md#list) - Get users\n* [create](docs/sdks/users/README.md#create) - Create user\n* [get](docs/sdks/users/README.md#get) - Get user\n* [update](docs/sdks/users/README.md#update) - Update user\n* [delete](docs/sdks/users/README.md#delete) - Delete user\n* [getGroups](docs/sdks/users/README.md#getgroups) - Get user groups\n* [listSubAccounts](docs/sdks/users/README.md#listsubaccounts) - Get user sub-accounts\n\n\u003c/details\u003e\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Global Parameters [global-parameters] --\u003e\n## Global Parameters\n\nA parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.\n\nFor example, you can set `account_id` to `\"\u003cid\u003e\"` at SDK initialization and then you do not have to pass the same value on calls to operations like `list`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.\n\n\n### Available Globals\n\nThe following global parameter is available.\nGlobal parameters can also be set via environment variable.\n\n| Name      | Type             | Description | Environment           |\n| --------- | ---------------- | ----------- | --------------------- |\n| accountId | java.lang.String | Account ID  | CLOUDINARY_ACCOUNT_ID |\n\n### Example\n\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        if (res.productEnvironmentsResponse().isPresent()) {\n            System.out.println(res.productEnvironmentsResponse().get());\n        }\n    }\n}\n```\n\u003c!-- End Global Parameters [global-parameters] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\n\n[`CldProvisioningException`](./src/main/java/models/errors/CldProvisioningException.java) is the base class for all HTTP error responses. It has the following properties:\n\n| Method           | Type                        | Description                                                              |\n| ---------------- | --------------------------- | ------------------------------------------------------------------------ |\n| `message()`      | `String`                    | Error message                                                            |\n| `code()`         | `int`                       | HTTP response status code eg `404`                                       |\n| `headers`        | `Map\u003cString, List\u003cString\u003e\u003e` | HTTP response headers                                                    |\n| `body()`         | `byte[]`                    | HTTP body as a byte array. Can be empty array if no body is returned.    |\n| `bodyAsString()` | `String`                    | HTTP body as a UTF-8 string. Can be empty string if no body is returned. |\n| `rawResponse()`  | `HttpResponse\u003c?\u003e`           | Raw HTTP response (body already read and not available for re-read)      |\n\n### Example\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Error;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.CldProvisioningException;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.io.InputStream;\nimport java.io.UncheckedIOException;\nimport java.lang.Exception;\nimport java.net.http.HttpResponse;\nimport java.util.Optional;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build();\n        try {\n\n            GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                    .enabled(true)\n                    .prefix(\"product\")\n                    .build();\n\n            GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                    .request(req)\n                    .call();\n\n            if (res.productEnvironmentsResponse().isPresent()) {\n                System.out.println(res.productEnvironmentsResponse().get());\n            }\n        } catch (CldProvisioningException ex) { // all SDK exceptions inherit from CldProvisioningException\n\n            // ex.ToString() provides a detailed error message including\n            // HTTP status code, headers, and error payload (if any)\n            System.out.println(ex);\n\n            // Base exception fields\n            var rawResponse = ex.rawResponse();\n            var headers = ex.headers();\n            var contentType = headers.first(\"Content-Type\");\n            int statusCode = ex.code();\n            Optional\u003cbyte[]\u003e responseBody = ex.body();\n\n            // different error subclasses may be thrown \n            // depending on the service call\n            if (ex instanceof ErrorResponse) {\n                var e = (ErrorResponse) ex;\n                // Check error data fields\n                e.data().ifPresent(payload -\u003e {\n                      Optional\u003cError\u003e error = payload.error();\n                      Optional\u003cHttpResponse\u003cInputStream\u003e\u003e rawResponse = payload.rawResponse();\n                });\n            }\n\n            // An underlying cause may be provided. If the error payload \n            // cannot be deserialized then the deserialization exception \n            // will be set as the cause.\n            if (ex.getCause() != null) {\n                var cause = ex.getCause();\n            }\n        } catch (UncheckedIOException ex) {\n            // handle IO error (connection, timeout, etc)\n        }    }\n}\n```\n\n### Error Classes\n**Primary error:**\n* [`CldProvisioningException`](./src/main/java/models/errors/CldProvisioningException.java): The base class for HTTP error responses.\n\n\u003cdetails\u003e\u003csummary\u003eLess common errors (8)\u003c/summary\u003e\n\n\u003cbr /\u003e\n\n**Network errors:**\n* `java.io.IOException` (always wrapped by `java.io.UncheckedIOException`). Commonly encountered subclasses of\n`IOException` include `java.net.ConnectException`, `java.net.SocketTimeoutException`, `EOFException` (there are\nmany more subclasses in the JDK platform).\n\n**Inherit from [`CldProvisioningException`](./src/main/java/models/errors/CldProvisioningException.java)**:\n* [`com.cloudinary.account.provisioning.models.errors.ErrorResponse`](./src/main/java/models/errors/com.cloudinary.account.provisioning.models.errors.ErrorResponse.java): Bad request. Applicable to 26 of 47 methods.*\n* [`com.cloudinary.account.provisioning.models.errors.PermissionsErrorResponse`](./src/main/java/models/errors/com.cloudinary.account.provisioning.models.errors.PermissionsErrorResponse.java): Applicable to 18 of 47 methods.*\n\n\n\u003c/details\u003e\n\n\\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- Start Server Selection [server] --\u003e\n## Server Selection\n\n### Select Server by Index\n\nYou can override the default server globally using the `.serverIndex(int serverIdx)` builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| #   | Server                            | Variables | Description                                     |\n| --- | --------------------------------- | --------- | ----------------------------------------------- |\n| 0   | `https://{region}.cloudinary.com` | `region`  | Regional API endpoints for optimal performance. |\n| 1   | `https://{host}`                  | `host`    | Custom domains for enterprise deployments.      |\n\nIf the selected server has variables, you may override its default values using the associated builder method(s):\n\n| Variable | BuilderMethod                 | Supported Values                            | Default                | Description                 |\n| -------- | ----------------------------- | ------------------------------------------- | ---------------------- | --------------------------- |\n| `region` | `region(ServerRegion region)` | - `\"api\"`\u003cbr/\u003e- `\"api-eu\"`\u003cbr/\u003e- `\"api-ap\"` | `\"api\"`                | Regional endpoint selection |\n| `host`   | `host(String host)`           | java.lang.String                            | `\"api.cloudinary.com\"` | API host domain.            |\n\n#### Example\n\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.SDK.Builder.ServerRegion;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .serverIndex(0)\n                .region(ServerRegion.API_AP)\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        if (res.productEnvironmentsResponse().isPresent()) {\n            System.out.println(res.productEnvironmentsResponse().get());\n        }\n    }\n}\n```\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:\n```java\npackage hello.world;\n\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.models.components.Security;\nimport com.cloudinary.account.provisioning.models.errors.ErrorResponse;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsRequest;\nimport com.cloudinary.account.provisioning.models.operations.GetProductEnvironmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorResponse, Exception {\n\n        CldProvisioning sdk = CldProvisioning.builder()\n                .serverURL(\"https://api.cloudinary.com\")\n                .accountId(\"\u003cid\u003e\")\n                .security(Security.builder()\n                    .provisioningApiKey(\"CLOUDINARY_PROVISIONING_API_KEY\")\n                    .provisioningApiSecret(\"CLOUDINARY_PROVISIONING_API_SECRET\")\n                    .build())\n            .build();\n\n        GetProductEnvironmentsRequest req = GetProductEnvironmentsRequest.builder()\n                .enabled(true)\n                .prefix(\"product\")\n                .build();\n\n        GetProductEnvironmentsResponse res = sdk.productEnvironments().list()\n                .request(req)\n                .call();\n\n        if (res.productEnvironmentsResponse().isPresent()) {\n            System.out.println(res.productEnvironmentsResponse().get());\n        }\n    }\n}\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\u003c!-- Start Custom HTTP Client [http-client] --\u003e\n## Custom HTTP Client\n\nThe Java SDK makes API calls using an `HTTPClient` that wraps the native\n[HttpClient](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpClient.html). This\nclient provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle\nerrors and response.\n\nThe `HTTPClient` interface allows you to either use the default `SpeakeasyHTTPClient` that comes with the SDK,\nor provide your own custom implementation with customized configuration such as custom executors, SSL context,\nconnection pools, and other HTTP client settings.\n\nThe interface provides synchronous (`send`) methods and asynchronous (`sendAsync`) methods. The `sendAsync` method\nis used to power the async SDK methods and returns a `CompletableFuture\u003cHttpResponse\u003cBlob\u003e\u003e` for non-blocking operations.\n\nThe following example shows how to add a custom header and handle errors:\n\n```java\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.utils.HTTPClient;\nimport com.cloudinary.account.provisioning.utils.SpeakeasyHTTPClient;\nimport com.cloudinary.account.provisioning.utils.Utils;\n\nimport java.io.IOException;\nimport java.net.URISyntaxException;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.io.InputStream;\nimport java.time.Duration;\n\npublic class Application {\n    public static void main(String[] args) {\n        // Create a custom HTTP client with hooks\n        HTTPClient httpClient = new HTTPClient() {\n            private final HTTPClient defaultClient = new SpeakeasyHTTPClient();\n            \n            @Override\n            public HttpResponse\u003cInputStream\u003e send(HttpRequest request) throws IOException, URISyntaxException, InterruptedException {\n                // Add custom header and timeout using Utils.copy()\n                HttpRequest modifiedRequest = Utils.copy(request)\n                    .header(\"x-custom-header\", \"custom value\")\n                    .timeout(Duration.ofSeconds(30))\n                    .build();\n                    \n                try {\n                    HttpResponse\u003cInputStream\u003e response = defaultClient.send(modifiedRequest);\n                    // Log successful response\n                    System.out.println(\"Request successful: \" + response.statusCode());\n                    return response;\n                } catch (Exception error) {\n                    // Log error\n                    System.err.println(\"Request failed: \" + error.getMessage());\n                    throw error;\n                }\n            }\n        };\n\n        CldProvisioning sdk = CldProvisioning.builder()\n            .client(httpClient)\n            .build();\n    }\n}\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eCustom HTTP Client Configuration\u003c/summary\u003e\n\nYou can also provide a completely custom HTTP client with your own configuration:\n\n```java\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.utils.HTTPClient;\nimport com.cloudinary.account.provisioning.utils.Blob;\nimport com.cloudinary.account.provisioning.utils.ResponseWithBody;\n\nimport java.io.IOException;\nimport java.net.URISyntaxException;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.io.InputStream;\nimport java.time.Duration;\nimport java.util.concurrent.Executors;\nimport java.util.concurrent.CompletableFuture;\n\npublic class Application {\n    public static void main(String[] args) {\n        // Custom HTTP client with custom configuration\n        HTTPClient customHttpClient = new HTTPClient() {\n            private final HttpClient client = HttpClient.newBuilder()\n                .executor(Executors.newFixedThreadPool(10))\n                .connectTimeout(Duration.ofSeconds(30))\n                // .sslContext(customSslContext) // Add custom SSL context if needed\n                .build();\n\n            @Override\n            public HttpResponse\u003cInputStream\u003e send(HttpRequest request) throws IOException, URISyntaxException, InterruptedException {\n                return client.send(request, HttpResponse.BodyHandlers.ofInputStream());\n            }\n\n            @Override\n            public CompletableFuture\u003cHttpResponse\u003cBlob\u003e\u003e sendAsync(HttpRequest request) {\n                // Convert response to HttpResponse\u003cBlob\u003e for async operations\n                return client.sendAsync(request, HttpResponse.BodyHandlers.ofPublisher())\n                    .thenApply(resp -\u003e new ResponseWithBody\u003c\u003e(resp, Blob::from));\n            }\n        };\n\n        CldProvisioning sdk = CldProvisioning.builder()\n            .client(customHttpClient)\n            .build();\n    }\n}\n```\n\n\u003c/details\u003e\n\nYou can also enable debug logging on the default `SpeakeasyHTTPClient`:\n\n```java\nimport com.cloudinary.account.provisioning.CldProvisioning;\nimport com.cloudinary.account.provisioning.utils.SpeakeasyHTTPClient;\n\npublic class Application {\n    public static void main(String[] args) {\n        SpeakeasyHTTPClient httpClient = new SpeakeasyHTTPClient();\n        httpClient.enableDebugLogging(true);\n\n        CldProvisioning sdk = CldProvisioning.builder()\n            .client(httpClient)\n            .build();\n    }\n}\n```\n\u003c!-- End Custom HTTP Client [http-client] --\u003e\n\n\u003c!-- Start Debugging [debug] --\u003e\n## Debugging\n\n### Debug\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nFor request and response logging (especially json bodies), call `enableHTTPDebugLogging(boolean)` on the SDK builder like so:\n\n```java\nSDK.builder()\n    .enableHTTPDebugLogging(true)\n    .build();\n```\nExample output:\n```\nSending request: http://localhost:35123/bearer#global GET\nRequest headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}\nReceived response: (GET http://localhost:35123/bearer#global) 200\nResponse headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}\nResponse body:\n{\n  \"authenticated\": true, \n  \"token\": \"global\"\n}\n```\n__WARNING__: This logging should only be used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. \u003ci\u003eAuthorization\u003c/i\u003e headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.\n\n__NOTE__: This is a convenience method that calls `HTTPClient.enableDebugLogging()`. The `SpeakeasyHTTPClient` honors this setting. If you are using a custom HTTP client, it is up to the custom client to honor this setting.\n\n\nAnother option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.\n\u003c!-- End Debugging [debug] --\u003e\n\n\u003c!-- Start Jackson Configuration [jackson] --\u003e\n## Jackson Configuration\n\nThe SDK ships with a pre-configured Jackson [`ObjectMapper`][jackson-databind] accessible via\n`JSON.getMapper()`. It is set up with type modules, strict deserializers, and the feature flags\nneeded for full SDK compatibility (including ISO-8601 `OffsetDateTime` serialization):\n\n```java\nimport com.cloudinary.account.provisioning.utils.JSON;\n\nString json = JSON.getMapper().writeValueAsString(response);\n```\n\nTo compose with your own `ObjectMapper`, register the provided `CloudinaryAccountProvisioningJacksonModule`, which\nbundles all the same modules and feature flags as a single plug-and-play module:\n\n```java\nimport com.cloudinary.account.provisioning.utils.CloudinaryAccountProvisioningJacksonModule;\nimport com.fasterxml.jackson.databind.ObjectMapper;\n\nObjectMapper myMapper = new ObjectMapper()\n    .registerModule(new CloudinaryAccountProvisioningJacksonModule());\n\nString json = myMapper.writeValueAsString(response);\n```\n\n[jackson-databind]: https://github.com/FasterXML/jackson-databind\n[jackson-jsr310]: https://github.com/FasterXML/jackson-modules-java8/tree/master/datetime\n\u003c!-- End Jackson Configuration [jackson] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=cloudinary-account-provisioning\u0026utm_campaign=java)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudinary%2Faccount-provisioning-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudinary%2Faccount-provisioning-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudinary%2Faccount-provisioning-java/lists"}