Package com.docusign.admin.api

Class UsersApi

java.lang.Object

com.docusign.admin.api.UsersApi

public class UsersApi
extends Object

UsersApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UsersApi.GetUserDSProfileOptions	GetUserDSProfileOptions Class.
class	UsersApi.GetUserDSProfilesByEmailOptions	GetUserDSProfilesByEmailOptions Class.
class	UsersApi.GetUserProfilesOptions	GetUserProfilesOptions Class.
class	UsersApi.GetUsersOptions	GetUsersOptions Class.

Constructor Summary

Constructors

Constructor	Description
UsersApi()	UsersApi.
UsersApi(ApiClient apiClient)	UsersApi.

Method Summary

Modifier and Type	Method	Description
UpdateResponse	activateMembership(UUID organizationId, UUID userId, UUID membershipId, ForceActivateMembershipRequest request)	Activates user memberships.
AddUserResponse	addOrUpdateUser(UUID organizationId, UUID accountId, NewMultiProductUserAddRequest request)	Creates and updates a multi-product user.
NewUserResponse	addUsers(UUID organizationId, UUID accountId, NewAccountUserRequest request)	Adds users to an account..
DeleteMembershipsResponse	closeMemberships(UUID organizationId, UUID userId, DeleteMembershipsRequest request)	Closes a user's memberships..
NewUserResponse	createUser(UUID organizationId, NewUserRequest request)	Creates a new user.
DeleteResponse	deleteIdentities(UUID organizationId, UUID userId, DeleteUserIdentityRequest requestModel)	Deletes user identities..
ApiClient	getApiClient()	getApiClient Method.
UsersDrilldownResponse	getUserDSProfile(UUID organizationId, UUID userId)	Returns user information using the userId for lookup..
UsersDrilldownResponse	getUserDSProfile(UUID organizationId, UUID userId, UsersApi.GetUserDSProfileOptions options)	Returns user information using the userId for lookup..
UsersDrilldownResponse	getUserDSProfilesByEmail(UUID organizationId)	Returns DS user profile information..
UsersDrilldownResponse	getUserDSProfilesByEmail(UUID organizationId, UsersApi.GetUserDSProfilesByEmailOptions options)	Returns DS user profile information..
UsersDrilldownResponse	getUserProfiles(UUID organizationId)	Returns user information..
UsersDrilldownResponse	getUserProfiles(UUID organizationId, UsersApi.GetUserProfilesOptions options)	Returns user information..
OrganizationUsersResponse	getUsers(UUID organizationId)	Returns information about the users in the organization.
OrganizationUsersResponse	getUsers(UUID organizationId, UsersApi.GetUsersOptions options)	Returns information about the users in the organization.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
UsersUpdateResponse	updateEmailAddress(UUID organizationId, UpdateUsersEmailRequest request)	Updates a user's email address..
UsersUpdateResponse	updateUser(UUID organizationId, UpdateUsersRequest request)	Updates a user..

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

public UsersApi()

UsersApi.

UsersApi

public UsersApi(ApiClient apiClient)

UsersApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

activateMembership

public UpdateResponse activateMembership(UUID organizationId,
                                         UUID userId,
                                         UUID membershipId,
                                         ForceActivateMembershipRequest request)
                                  throws ApiException

Activates user memberships. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

userId - The user ID Guid (required)

membershipId - The membership ID Guid (required)

request - Additional details about the user's membership (required)

Returns:

UpdateResponse

Throws:

ApiException - if fails to make API call

addOrUpdateUser

public AddUserResponse addOrUpdateUser(UUID organizationId,
                                       UUID accountId,
                                       NewMultiProductUserAddRequest request)
                                throws ApiException

Creates and updates a multi-product user. Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

request - The request object (required)

Returns:

AddUserResponse

Throws:

ApiException - if fails to make API call

addUsers

public NewUserResponse addUsers(UUID organizationId,
                                UUID accountId,
                                NewAccountUserRequest request)
                         throws ApiException

Adds users to an account.. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

accountId - The account ID Guid (required)

request - The details for the users to add to the account (required)

Returns:

NewUserResponse

Throws:

ApiException - if fails to make API call

closeMemberships

public DeleteMembershipsResponse closeMemberships(UUID organizationId,
                                                  UUID userId,
                                                  DeleteMembershipsRequest request)
                                           throws ApiException

Closes a user's memberships.. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

userId - The user ID Guid (required)

request - The details about which membership to close (required)

Returns:

DeleteMembershipsResponse

Throws:

ApiException - if fails to make API call

createUser

public NewUserResponse createUser(UUID organizationId,
                                  NewUserRequest request)
                           throws ApiException

Creates a new user. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

request - Details about the user to be added (required)

Returns:

NewUserResponse

Throws:

ApiException - if fails to make API call

deleteIdentities

public DeleteResponse deleteIdentities(UUID organizationId,
                                       UUID userId,
                                       DeleteUserIdentityRequest requestModel)
                                throws ApiException

Deletes user identities.. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

userId - The user ID Guid (required)

requestModel - The details for the user identities to be deleted (required)

Returns:

DeleteResponse

Throws:

ApiException - if fails to make API call

getUserDSProfile

public UsersDrilldownResponse getUserDSProfile(UUID organizationId,
                                               UUID userId)
                                        throws ApiException

Returns user information using the userId for lookup.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

userId - The user ID Guid (required)

Returns:

UsersDrilldownResponse

Throws:

ApiException

getUserDSProfile

public UsersDrilldownResponse getUserDSProfile(UUID organizationId,
                                               UUID userId,
                                               UsersApi.GetUserDSProfileOptions options)
                                        throws ApiException

Returns user information using the userId for lookup.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

userId - The user ID Guid (required)

options - for modifying the method behavior.

Returns:

UsersDrilldownResponse

Throws:

ApiException - if fails to make API call

getUserDSProfilesByEmail

public UsersDrilldownResponse getUserDSProfilesByEmail(UUID organizationId)
                                                throws ApiException

Returns DS user profile information.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

Returns:

UsersDrilldownResponse

Throws:

ApiException

getUserDSProfilesByEmail

public UsersDrilldownResponse getUserDSProfilesByEmail(UUID organizationId,
                                                       UsersApi.GetUserDSProfilesByEmailOptions options)
                                                throws ApiException

Returns DS user profile information.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

options - for modifying the method behavior.

Returns:

UsersDrilldownResponse

Throws:

ApiException - if fails to make API call

getUserProfiles

public UsersDrilldownResponse getUserProfiles(UUID organizationId)
                                       throws ApiException

Returns user information.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

Returns:

UsersDrilldownResponse

Throws:

ApiException

getUserProfiles

public UsersDrilldownResponse getUserProfiles(UUID organizationId,
                                              UsersApi.GetUserProfilesOptions options)
                                       throws ApiException

Returns user information.. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

options - for modifying the method behavior.

Returns:

UsersDrilldownResponse

Throws:

ApiException - if fails to make API call

getUsers

public OrganizationUsersResponse getUsers(UUID organizationId)
                                   throws ApiException

Returns information about the users in the organization. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationUsersResponse

Throws:

ApiException

getUsers

public OrganizationUsersResponse getUsers(UUID organizationId,
                                          UsersApi.GetUsersOptions options)
                                   throws ApiException

Returns information about the users in the organization. Required scopes: user_read

Parameters:

organizationId - The organization ID Guid (required)

options - for modifying the method behavior.

Returns:

OrganizationUsersResponse

Throws:

ApiException - if fails to make API call

updateEmailAddress

public UsersUpdateResponse updateEmailAddress(UUID organizationId,
                                              UpdateUsersEmailRequest request)
                                       throws ApiException

Updates a user's email address.. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

request - The details about which email addresses to update (required)

Returns:

UsersUpdateResponse

Throws:

ApiException - if fails to make API call

updateUser

public UsersUpdateResponse updateUser(UUID organizationId,
                                      UpdateUsersRequest request)
                               throws ApiException

Updates a user.. Required scopes: user_write

Parameters:

organizationId - The organization ID Guid (required)

request - The user details to update (required)

Returns:

UsersUpdateResponse

Throws:

ApiException - if fails to make API call