com.docusign.esign.api

Class GroupsApi

java.lang.Object

com.docusign.esign.api.GroupsApi

public class GroupsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GroupsApi.ListGroupsOptions
class	GroupsApi.ListGroupUsersOptions

Constructor Summary

Constructors

Constructor and Description
GroupsApi()
GroupsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
GroupInformation	createGroups(String accountId, GroupInformation groupInformation) Creates one or more groups for the account.
BrandsResponse	deleteBrands(String accountId, String groupId, BrandsRequest brandsRequest) Deletes brand information from the requested group.
GroupInformation	deleteGroups(String accountId, GroupInformation groupInformation) Deletes an existing user group.
UsersResponse	deleteGroupUsers(String accountId, String groupId, UserInfoList userInfoList) Deletes one or more users from a gro Deletes one or more users from a group.
ApiClient	getApiClient()
BrandsResponse	getBrands(String accountId, String groupId) Gets group brand ID Information.
GroupInformation	listGroups(String accountId) Gets information about groups associated with the account.
GroupInformation	listGroups(String accountId, GroupsApi.ListGroupsOptions options) Gets information about groups associated with the account.
UsersResponse	listGroupUsers(String accountId, String groupId) Gets a list of users in a group.
UsersResponse	listGroupUsers(String accountId, String groupId, GroupsApi.ListGroupUsersOptions options) Gets a list of users in a group.
void	setApiClient(ApiClient apiClient)
BrandsResponse	updateBrands(String accountId, String groupId, BrandsRequest brandsRequest) Adds group brand ID information to a group.
GroupInformation	updateGroups(String accountId, GroupInformation groupInformation) Updates the group information for a group.
UsersResponse	updateGroupUsers(String accountId, String groupId, UserInfoList userInfoList) Adds one or more users to an existing group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupsApi

public GroupsApi()

GroupsApi

public GroupsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createGroups

public GroupInformation createGroups(String accountId,
                            GroupInformation groupInformation)
                              throws ApiException

Creates one or more groups for the account. Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupInformation - (optional)

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call

deleteBrands

public BrandsResponse deleteBrands(String accountId,
                          String groupId,
                          BrandsRequest brandsRequest)
                            throws ApiException

Deletes brand information from the requested group. Deletes brand information from the requested group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

brandsRequest - (optional)

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

deleteGroupUsers

public UsersResponse deleteGroupUsers(String accountId,
                             String groupId,
                             UserInfoList userInfoList)
                               throws ApiException

Deletes one or more users from a gro Deletes one or more users from a group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

userInfoList - (optional)

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

deleteGroups

public GroupInformation deleteGroups(String accountId,
                            GroupInformation groupInformation)
                              throws ApiException

Deletes an existing user group. Deletes an existing user group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupInformation - (optional)

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call

getBrands

public BrandsResponse getBrands(String accountId,
                       String groupId)
                         throws ApiException

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

listGroupUsers

public UsersResponse listGroupUsers(String accountId,
                           String groupId)
                             throws ApiException

Gets a list of users in a group. Retrieves a list of users in a group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

Returns:

UsersResponse

Throws:

ApiException

listGroupUsers

public UsersResponse listGroupUsers(String accountId,
                           String groupId,
                           GroupsApi.ListGroupUsersOptions options)
                             throws ApiException

Gets a list of users in a group. Retrieves a list of users in a group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

options - for modifying the method behavior.

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

listGroups

public GroupInformation listGroups(String accountId)
                            throws ApiException

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

GroupInformation

Throws:

ApiException

listGroups

public GroupInformation listGroups(String accountId,
                          GroupsApi.ListGroupsOptions options)
                            throws ApiException

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call

updateBrands

public BrandsResponse updateBrands(String accountId,
                          String groupId,
                          BrandsRequest brandsRequest)
                            throws ApiException

Adds group brand ID information to a group. Adds group brand ID information to a group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

brandsRequest - (optional)

Returns:

BrandsResponse

Throws:

ApiException - if fails to make API call

updateGroupUsers

public UsersResponse updateGroupUsers(String accountId,
                             String groupId,
                             UserInfoList userInfoList)
                               throws ApiException

Adds one or more users to an existing group. Adds one or more users to an existing group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupId - The ID of the group being accessed. (required)

userInfoList - (optional)

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

updateGroups

public GroupInformation updateGroups(String accountId,
                            GroupInformation groupInformation)
                              throws ApiException

Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

groupInformation - (optional)

Returns:

GroupInformation

Throws:

ApiException - if fails to make API call