com.docusign.admin.api

Class DsGroupsApi

java.lang.Object

com.docusign.admin.api.DsGroupsApi

public class DsGroupsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DsGroupsApi.GetDSGroupsOptions
class	DsGroupsApi.GetDSGroupUsersOptions

Constructor Summary

Constructors

Constructor and Description
DsGroupsApi()
DsGroupsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DSGroupResponse	addDSGroup(UUID organizationId, UUID accountId, DSGroupAddRequest addRequest) Add a new DSGroup Required scopes: user_write
AddDSGroupAndUsersResponse	addDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DSGroupUsersAddRequest dSGroupUsersAddRequest) Add list of users to a DSGroup Required scopes: user_write
void	deleteDSGroup(UUID organizationId, UUID accountId, UUID dsGroupId) Delete a DSGroup Required scopes: user_write
ApiClient	getApiClient()
DSGroupResponse	getDSGroup(UUID organizationId, UUID accountId, UUID dsGroupId) Get list of DSGroup Required scopes: user_read
DSGroupListResponse	getDSGroups(UUID organizationId, UUID accountId) Get list of DSGroups Required scopes: user_read
DSGroupListResponse	getDSGroups(UUID organizationId, UUID accountId, DsGroupsApi.GetDSGroupsOptions options) Get list of DSGroups Required scopes: user_read
DSGroupAndUsersResponse	getDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId) Get list of users in a DSGroup Required scopes: user_read
DSGroupAndUsersResponse	getDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DsGroupsApi.GetDSGroupUsersOptions options) Get list of users in a DSGroup Required scopes: user_read
RemoveDSGroupUsersResponse	removeDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DSGroupUsersRemoveRequest dSGroupUsersRemoveRequest) Remove users from a DSGroup Required scopes: user_write
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DsGroupsApi

public DsGroupsApi()

DsGroupsApi

public DsGroupsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addDSGroup

public DSGroupResponse addDSGroup(UUID organizationId,
                                  UUID accountId,
                                  DSGroupAddRequest addRequest)
                           throws ApiException

Add a new DSGroup Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

addRequest - Add DSGroup request object (required)

Returns:

DSGroupResponse

Throws:

ApiException - if fails to make API call

addDSGroupUsers

public AddDSGroupAndUsersResponse addDSGroupUsers(UUID organizationId,
                                                  UUID accountId,
                                                  UUID dsGroupId,
                                                  DSGroupUsersAddRequest dSGroupUsersAddRequest)
                                           throws ApiException

Add list of users to a DSGroup Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The DSGroup ID GUID (required)

dSGroupUsersAddRequest - Add DSGroup users request object (required)

Returns:

AddDSGroupAndUsersResponse

Throws:

ApiException - if fails to make API call

deleteDSGroup

public void deleteDSGroup(UUID organizationId,
                          UUID accountId,
                          UUID dsGroupId)
                   throws ApiException

Delete a DSGroup Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The DSGroup ID GUID (required)

Throws:

ApiException - if fails to make API call

getDSGroup

public DSGroupResponse getDSGroup(UUID organizationId,
                                  UUID accountId,
                                  UUID dsGroupId)
                           throws ApiException

Get list of DSGroup Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The dsGroup ID GUID (required)

Returns:

DSGroupResponse

Throws:

ApiException - if fails to make API call

getDSGroupUsers

public DSGroupAndUsersResponse getDSGroupUsers(UUID organizationId,
                                               UUID accountId,
                                               UUID dsGroupId)
                                        throws ApiException

Get list of users in a DSGroup Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The DSGroup ID GUID (required)

Returns:

DSGroupAndUsersResponse

Throws:

ApiException

getDSGroupUsers

public DSGroupAndUsersResponse getDSGroupUsers(UUID organizationId,
                                               UUID accountId,
                                               UUID dsGroupId,
                                               DsGroupsApi.GetDSGroupUsersOptions options)
                                        throws ApiException

Get list of users in a DSGroup Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The DSGroup ID GUID (required)

options - for modifying the method behavior.

Returns:

DSGroupAndUsersResponse

Throws:

ApiException - if fails to make API call

getDSGroups

public DSGroupListResponse getDSGroups(UUID organizationId,
                                       UUID accountId)
                                throws ApiException

Get list of DSGroups Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

Returns:

DSGroupListResponse

Throws:

ApiException

getDSGroups

public DSGroupListResponse getDSGroups(UUID organizationId,
                                       UUID accountId,
                                       DsGroupsApi.GetDSGroupsOptions options)
                                throws ApiException

Get list of DSGroups Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

options - for modifying the method behavior.

Returns:

DSGroupListResponse

Throws:

ApiException - if fails to make API call

removeDSGroupUsers

public RemoveDSGroupUsersResponse removeDSGroupUsers(UUID organizationId,
                                                     UUID accountId,
                                                     UUID dsGroupId,
                                                     DSGroupUsersRemoveRequest dSGroupUsersRemoveRequest)
                                              throws ApiException

Remove users from a DSGroup Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

dsGroupId - The DSGroup ID GUID (required)

dSGroupUsersRemoveRequest - Remove DSGroup users request object (required)

Returns:

RemoveDSGroupUsersResponse

Throws:

ApiException - if fails to make API call