Skip to content

README.md

Latest commit

 

History

History
345 lines (252 loc) · 16.4 KB

README.md

File metadata and controls

345 lines (252 loc) · 16.4 KB

AccessKeys

Overview

Available Operations

list

Retrieve an array of all access keys for a product environment.

Learn more about retrieving access keys. https://cloudinary.com/documentation/provisioning_api#get_access_keys

Example Usage

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        CldProvisioning sdk = CldProvisioning.builder()
                .accountId("<id>")
                .security(Security.builder()
                    .provisioningApiKey("CLOUDINARY_PROVISIONING_API_KEY")
                    .provisioningApiSecret("CLOUDINARY_PROVISIONING_API_SECRET")
                    .build())
            .build();

        GetAccessKeysRequest req = GetAccessKeysRequest.builder()
                .subAccountId("abcde1fghij2klmno3pqrst4uvwxy5z")
                .sortBy(SortBy.CREATED_AT)
                .sortOrder(SortOrder.ASC)
                .build();

        GetAccessKeysResponse res = sdk.accessKeys().list()
                .request(req)
                .call();

        if (res.accessKeysResponse().isPresent()) {
            System.out.println(res.accessKeysResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GetAccessKeysRequest ✔️ The request object to use for the request.

Response

GetAccessKeysResponse

Errors

Error Type Status Code Content Type
models/errors/ErrorResponse 401, 404, 420, 429 application/json
models/errors/SDKException 4XX, 5XX */*

generate

Generate a new access key.

Learn more about generating access keys. https://cloudinary.com/documentation/provisioning_api#generate_an_access_key

Example Usage

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.AccessKeyRequest;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.GenerateAccessKeyRequest;
import com.cloudinary.account.provisioning.models.operations.GenerateAccessKeyResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        CldProvisioning sdk = CldProvisioning.builder()
                .accountId("<id>")
                .security(Security.builder()
                    .provisioningApiKey("CLOUDINARY_PROVISIONING_API_KEY")
                    .provisioningApiSecret("CLOUDINARY_PROVISIONING_API_SECRET")
                    .build())
            .build();

        GenerateAccessKeyRequest req = GenerateAccessKeyRequest.builder()
                .subAccountId("abcde1fghij2klmno3pqrst4uvwxy5z")
                .accessKeyRequest(AccessKeyRequest.builder()
                    .name("main_key")
                    .enabled(true)
                    .build())
                .build();

        GenerateAccessKeyResponse res = sdk.accessKeys().generate()
                .request(req)
                .call();

        if (res.accessKey().isPresent()) {
            System.out.println(res.accessKey().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GenerateAccessKeyRequest ✔️ The request object to use for the request.

Response

GenerateAccessKeyResponse

Errors

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

deleteByName

Delete a specific access key by name.

Learn more about deleting access keys. https://cloudinary.com/documentation/provisioning_api#delete_an_access_key

Example Usage

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.DeleteAccessKeyByNameRequest;
import com.cloudinary.account.provisioning.models.operations.DeleteAccessKeyByNameResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        CldProvisioning sdk = CldProvisioning.builder()
                .accountId("<id>")
                .security(Security.builder()
                    .provisioningApiKey("CLOUDINARY_PROVISIONING_API_KEY")
                    .provisioningApiSecret("CLOUDINARY_PROVISIONING_API_SECRET")
                    .build())
            .build();

        DeleteAccessKeyByNameRequest req = DeleteAccessKeyByNameRequest.builder()
                .subAccountId("abcde1fghij2klmno3pqrst4uvwxy5z")
                .name("main_key")
                .build();

        DeleteAccessKeyByNameResponse res = sdk.accessKeys().deleteByName()
                .request(req)
                .call();

        if (res.successResponse().isPresent()) {
            System.out.println(res.successResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description
request DeleteAccessKeyByNameRequest ✔️ The request object to use for the request.

Response

DeleteAccessKeyByNameResponse

Errors

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

update

Update the name and/or status of an existing access key.

Learn more about updating access keys. https://cloudinary.com/documentation/provisioning_api#update_an_access_key

Example Usage

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.*;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.UpdateAccessKeyRequest;
import com.cloudinary.account.provisioning.models.operations.UpdateAccessKeyResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        CldProvisioning sdk = CldProvisioning.builder()
                .accountId("<id>")
                .security(Security.builder()
                    .provisioningApiKey("CLOUDINARY_PROVISIONING_API_KEY")
                    .provisioningApiSecret("CLOUDINARY_PROVISIONING_API_SECRET")
                    .build())
            .build();

        UpdateAccessKeyRequest req = UpdateAccessKeyRequest.builder()
                .subAccountId("abcde1fghij2klmno3pqrst4uvwxy5z")
                .key("814814814814814")
                .accessKeyUpdateRequest(AccessKeyUpdateRequest.builder()
                    .name("main_key")
                    .enabled(true)
                    .dedicatedFor(DedicatedFor.WEBHOOKS)
                    .build())
                .build();

        UpdateAccessKeyResponse res = sdk.accessKeys().update()
                .request(req)
                .call();

        if (res.accessKey().isPresent()) {
            System.out.println(res.accessKey().get());
        }
    }
}

Parameters

Parameter Type Required Description
request UpdateAccessKeyRequest ✔️ The request object to use for the request.

Response

UpdateAccessKeyResponse

Errors

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

delete

Delete a specific access key.

Learn more about deleting access keys. https://cloudinary.com/documentation/provisioning_api#delete_an_access_key

Example Usage

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.DeleteAccessKeyRequest;
import com.cloudinary.account.provisioning.models.operations.DeleteAccessKeyResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        CldProvisioning sdk = CldProvisioning.builder()
                .accountId("<id>")
                .security(Security.builder()
                    .provisioningApiKey("CLOUDINARY_PROVISIONING_API_KEY")
                    .provisioningApiSecret("CLOUDINARY_PROVISIONING_API_SECRET")
                    .build())
            .build();

        DeleteAccessKeyRequest req = DeleteAccessKeyRequest.builder()
                .subAccountId("abcde1fghij2klmno3pqrst4uvwxy5z")
                .key("814814814814814")
                .build();

        DeleteAccessKeyResponse res = sdk.accessKeys().delete()
                .request(req)
                .call();

        if (res.successResponse().isPresent()) {
            System.out.println(res.successResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description
request DeleteAccessKeyRequest ✔️ The request object to use for the request.

Response

DeleteAccessKeyResponse

Errors

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