UserGroups

Overview

Available Operations

list - Get User Groups
create - Create User Group
get - Get User Group
update - Update User Group
delete - Delete User Group
listUsers - Get Users in User Group
addUser - Add User to User Group
removeUser - Remove User from User Group

list

Retrieve an array of all user groups in the account.

Learn more about retrieving user groups. https://cloudinary.com/documentation/provisioning_api#get_user_groups

Example Usage: UserGroups

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.GetUserGroupsResponse;
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();

        GetUserGroupsResponse res = sdk.userGroups().list()
                .extendedDetails(true)
                .call();

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

Example Usage: UserGroupsExtendedDetails

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.GetUserGroupsResponse;
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();

        GetUserGroupsResponse res = sdk.userGroups().list()
                .extendedDetails(true)
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`extendedDetails`	Optional<Boolean>	➖	Whether to only return extended (true) or basic information about the group (false). Default: false.	true

Response

GetUserGroupsResponse

Errors

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

create

Create a new user group for the account.

Learn more about creating user groups. https://cloudinary.com/documentation/provisioning_api#create_user_group

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.components.UserGroupRequest;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.CreateUserGroupResponse;
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();

        UserGroupRequest req = UserGroupRequest.builder()
                .name("Designers")
                .extendedDetails(false)
                .build();

        CreateUserGroupResponse res = sdk.userGroups().create()
                .request(req)
                .call();

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

Parameters

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

Response

CreateUserGroupResponse

Errors

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

get

Retrieve a specific user group.

Learn more about retrieving a specific user group. https://cloudinary.com/documentation/provisioning_api#get_user_group

Example Usage: UserGroupDesigners

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.GetUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.GetUserGroupResponse;
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();

        GetUserGroupRequest req = GetUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .extendedDetails(true)
                .build();

        GetUserGroupResponse res = sdk.userGroups().get()
                .request(req)
                .call();

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

Example Usage: UserGroupDesignersExtendedDetails

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.GetUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.GetUserGroupResponse;
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();

        GetUserGroupRequest req = GetUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .extendedDetails(true)
                .build();

        GetUserGroupResponse res = sdk.userGroups().get()
                .request(req)
                .call();

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

Parameters

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

Response

GetUserGroupResponse

Errors

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

update

Update the name of a specified user group.

Learn more about updating a specific user group. https://cloudinary.com/documentation/provisioning_api#update_user_group

Example Usage: UserGroupDesignersRequest

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.components.UserGroupRequest;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.UpdateUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.UpdateUserGroupResponse;
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();

        UpdateUserGroupRequest req = UpdateUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .userGroupRequest(UserGroupRequest.builder()
                    .name("Designers and Creatives")
                    .build())
                .build();

        UpdateUserGroupResponse res = sdk.userGroups().update()
                .request(req)
                .call();

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

Example Usage: UserGroupUpdate

package hello.world;

import com.cloudinary.account.provisioning.CldProvisioning;
import com.cloudinary.account.provisioning.models.components.Security;
import com.cloudinary.account.provisioning.models.components.UserGroupRequest;
import com.cloudinary.account.provisioning.models.errors.ErrorResponse;
import com.cloudinary.account.provisioning.models.operations.UpdateUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.UpdateUserGroupResponse;
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();

        UpdateUserGroupRequest req = UpdateUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .userGroupRequest(UserGroupRequest.builder()
                    .name("Designers")
                    .extendedDetails(false)
                    .build())
                .build();

        UpdateUserGroupResponse res = sdk.userGroups().update()
                .request(req)
                .call();

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

Parameters

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

Response

UpdateUserGroupResponse

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 user group with the specified ID.

Learn more about deleting a specific user group. https://cloudinary.com/documentation/provisioning_api#delete_user_group

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.DeleteUserGroupResponse;
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();

        DeleteUserGroupResponse res = sdk.userGroups().delete()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`groupId`	String	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27

Response

DeleteUserGroupResponse

Errors

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

listUsers

Retrieve the users in the group with the specified ID.

Learn more about retrieving users in a specific user group. https://cloudinary.com/documentation/provisioning_api#get_user_group_users

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.GetUsersInUserGroupResponse;
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();

        GetUsersInUserGroupResponse res = sdk.userGroups().listUsers()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`groupId`	String	✔️	The ID of the user group.	7f08f1f1fc910bf1f25274aef11d27

Response

GetUsersInUserGroupResponse

Errors

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

addUser

Add a user to a group with the specified ID.

Learn more about adding users to a specific user group. https://cloudinary.com/documentation/provisioning_api#add_user_to_group

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.AddUserToUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.AddUserToUserGroupResponse;
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();

        AddUserToUserGroupRequest req = AddUserToUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .userId("0abed8dfcc039ea05e2a1d494fd442")
                .build();

        AddUserToUserGroupResponse res = sdk.userGroups().addUser()
                .request(req)
                .call();

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

Parameters

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

Response

AddUserToUserGroupResponse

Errors

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

removeUser

Remove a user from a group with the specified ID.

Learn more about removing users from a specific user group. https://cloudinary.com/documentation/provisioning_api#remove_user_from_group

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.RemoveUserFromUserGroupRequest;
import com.cloudinary.account.provisioning.models.operations.RemoveUserFromUserGroupResponse;
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();

        RemoveUserFromUserGroupRequest req = RemoveUserFromUserGroupRequest.builder()
                .groupId("7f08f1f1fc910bf1f25274aef11d27")
                .userId("0abed8dfcc039ea05e2a1d494fd442")
                .build();

        RemoveUserFromUserGroupResponse res = sdk.userGroups().removeUser()
                .request(req)
                .call();

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

Parameters

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

Response

RemoveUserFromUserGroupResponse

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

UserGroups

Overview

Available Operations

list

Example Usage: UserGroups

Example Usage: UserGroupsExtendedDetails

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage: UserGroupDesigners

Example Usage: UserGroupDesignersExtendedDetails

Parameters

Response

Errors

update

Example Usage: UserGroupDesignersRequest

Example Usage: UserGroupUpdate

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

listUsers

Example Usage

Parameters

Response

Errors

addUser

Example Usage

Parameters

Response

Errors

removeUser

Example Usage

Parameters

Response

Errors