Package com.docusign.admin.api

Class AccountsApi

java.lang.Object

com.docusign.admin.api.AccountsApi

public class AccountsApi
extends Object

AccountsApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AccountsApi.GetGroupsOptions	GetGroupsOptions Class.
class	AccountsApi.GetOrganizationsOptions	GetOrganizationsOptions Class.

Constructor Summary

Constructors

Constructor	Description
AccountsApi()	AccountsApi.
AccountsApi(ApiClient apiClient)	AccountsApi.

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	getApiClient Method.
MemberGroupsResponse	getGroups(UUID organizationId, UUID accountId)	Returns the list of groups in an account..
MemberGroupsResponse	getGroups(UUID organizationId, UUID accountId, AccountsApi.GetGroupsOptions options)	Returns the list of groups in an account..
ApiResponse<MemberGroupsResponse>	getGroupsWithHttpInfo(UUID organizationId, UUID accountId, AccountsApi.GetGroupsOptions options)	Returns the list of groups in an account.
OrganizationsResponse	getOrganizations()	Returns the list of organizations of which the authenticated user is a member..
OrganizationsResponse	getOrganizations(AccountsApi.GetOrganizationsOptions options)	Returns the list of organizations of which the authenticated user is a member..
ApiResponse<OrganizationsResponse>	getOrganizationsWithHttpInfo(AccountsApi.GetOrganizationsOptions options)	Returns the list of organizations of which the authenticated user is a member.
PermissionsResponse	getPermissions(UUID organizationId, UUID accountId)	Returns the list of permission profiles in an account..
ApiResponse<PermissionsResponse>	getPermissionsWithHttpInfo(UUID organizationId, UUID accountId)	Returns the list of permission profiles in an account.
IndividualUserDataRedactionResponse	redactIndividualMembershipData(UUID accountId, IndividualMembershipDataRedactionRequest requestModel)	Redacts membership data for users with memberships in an account..
ApiResponse<IndividualUserDataRedactionResponse>	redactIndividualMembershipDataWithHttpInfo(UUID accountId, IndividualMembershipDataRedactionRequest requestModel)	Redacts membership data for users with memberships in an account.
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi.

AccountsApi

public AccountsApi(ApiClient apiClient)

AccountsApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

getGroups

public MemberGroupsResponse getGroups(UUID organizationId,
                                      UUID accountId)
                               throws ApiException

Returns the list of groups in an account.. Required scopes: group_read

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

Returns:

MemberGroupsResponse

Throws:

ApiException

getGroups

public MemberGroupsResponse getGroups(UUID organizationId,
                                      UUID accountId,
                                      AccountsApi.GetGroupsOptions options)
                               throws ApiException

Returns the list of groups in an account.. Required scopes: group_read

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

options - for modifying the method behavior.

Returns:

MemberGroupsResponse

Throws:

ApiException - if fails to make API call

getGroupsWithHttpInfo

public ApiResponse<MemberGroupsResponse> getGroupsWithHttpInfo(UUID organizationId,
                                                               UUID accountId,
                                                               AccountsApi.GetGroupsOptions options)
                                                        throws ApiException

Returns the list of groups in an account. Required scopes: group_read

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

options - for modifying the method behavior.

Returns:

MemberGroupsResponse

Throws:

ApiException - if fails to make API call

getOrganizations

public OrganizationsResponse getOrganizations()
                                       throws ApiException

Returns the list of organizations of which the authenticated user is a member.. Required scopes: organization_read

Returns:

OrganizationsResponse

Throws:

ApiException

getOrganizations

public OrganizationsResponse getOrganizations(AccountsApi.GetOrganizationsOptions options)
                                       throws ApiException

Returns the list of organizations of which the authenticated user is a member.. Required scopes: organization_read

Parameters:

options - for modifying the method behavior.

Returns:

OrganizationsResponse

Throws:

ApiException - if fails to make API call

getOrganizationsWithHttpInfo

public ApiResponse<OrganizationsResponse> getOrganizationsWithHttpInfo(AccountsApi.GetOrganizationsOptions options)
                                                                throws ApiException

Returns the list of organizations of which the authenticated user is a member. Required scopes: organization_read

Parameters:

options - for modifying the method behavior.

Returns:

OrganizationsResponse

Throws:

ApiException - if fails to make API call

getPermissions

public PermissionsResponse getPermissions(UUID organizationId,
                                          UUID accountId)
                                   throws ApiException

Returns the list of permission profiles in an account.. Required scopes: permission_read

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

getPermissionsWithHttpInfo

public ApiResponse<PermissionsResponse> getPermissionsWithHttpInfo(UUID organizationId,
                                                                   UUID accountId)
                                                            throws ApiException

Returns the list of permission profiles in an account. Required scopes: permission_read

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

redactIndividualMembershipData

public IndividualUserDataRedactionResponse redactIndividualMembershipData(UUID accountId,
                                                                          IndividualMembershipDataRedactionRequest requestModel)
                                                                   throws ApiException

Redacts membership data for users with memberships in an account.. Required scopes: user_data_redact

Parameters:

accountId - The account ID Guid (required)

requestModel - The request body describing the membership to be redacted (required)

Returns:

IndividualUserDataRedactionResponse

Throws:

ApiException - if fails to make API call

redactIndividualMembershipDataWithHttpInfo

public ApiResponse<IndividualUserDataRedactionResponse> redactIndividualMembershipDataWithHttpInfo(UUID accountId,
                                                                                                   IndividualMembershipDataRedactionRequest requestModel)
                                                                                            throws ApiException

Redacts membership data for users with memberships in an account. Required scopes: user_data_redact

Parameters:

accountId - The account ID Guid (required)

requestModel - The request body describing the membership to be redacted (required)

Returns:

IndividualUserDataRedactionResponse

Throws:

ApiException - if fails to make API call