com.docusign.esign.api

Class UsersApi

java.lang.Object

com.docusign.esign.api.UsersApi

public class UsersApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UsersApi.GetInformationOptions
class	UsersApi.GetProfileImageOptions
class	UsersApi.GetSignatureImageOptions
class	UsersApi.ListOptions
class	UsersApi.UpdateSignatureOptions

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
NewUsersSummary	create(String accountId, NewUsersDefinition newUsersDefinition) Adds news user to the specified account.
UserSignaturesInformation	createSignatures(String accountId, String userId, UserSignaturesInformation userSignaturesInformation) Adds user Signature and initials images to a Signature.
UsersResponse	delete(String accountId, UserInfoList userInfoList) Removes users account privileges.
ContactUpdateResponse	deleteContacts(String accountId, ContactModRequest contactModRequest) Delete contacts associated with an account for the DocuSign service.
ContactUpdateResponse	deleteContactWithId(String accountId, String contactId) Replaces a particular contact associated with an account for the DocuSign service.
CustomSettingsInformation	deleteCustomSettings(String accountId, String userId, CustomSettingsInformation customSettingsInformation) Deletes custom user settings for a specified user.
void	deleteProfileImage(String accountId, String userId) Deletes the user profile image for the specified user.
void	deleteSignature(String accountId, String userId, String signatureId) Removes removes signature information for the specified user.
UserSignature	deleteSignatureImage(String accountId, String userId, String signatureId, String imageType) Deletes the user initials image or the user signature image for the specified user.
ApiClient	getApiClient()
ContactGetResponse	getContactById(String accountId, String contactId) Gets a particular contact associated with the user's account.
UserInformation	getInformation(String accountId, String userId) Gets the user information for a specified user.
UserInformation	getInformation(String accountId, String userId, UsersApi.GetInformationOptions options) Gets the user information for a specified user.
UserProfile	getProfile(String accountId, String userId) Retrieves the user profile for a specified user.
byte[]	getProfileImage(String accountId, String userId) Retrieves the user profile image for the specified user.
byte[]	getProfileImage(String accountId, String userId, UsersApi.GetProfileImageOptions options) Retrieves the user profile image for the specified user.
UserSettingsInformation	getSettings(String accountId, String userId) Gets the user account settings for a specified user.
UserSignature	getSignature(String accountId, String userId, String signatureId) Gets the user signature information for the specified user.
byte[]	getSignatureImage(String accountId, String userId, String signatureId, String imageType) Retrieves the user initials image or the user signature image for the specified user.
byte[]	getSignatureImage(String accountId, String userId, String signatureId, String imageType, UsersApi.GetSignatureImageOptions options) Retrieves the user initials image or the user signature image for the specified user.
UserInformationList	list(String accountId) Retrieves the list of users for the specified account.
UserInformationList	list(String accountId, UsersApi.ListOptions options) Retrieves the list of users for the specified account.
CustomSettingsInformation	listCustomSettings(String accountId, String userId) Retrieves the custom user settings for a specified user.
UserSignaturesInformation	listSignatures(String accountId, String userId) Retrieves a list of user signature definitions for a specified user.
ContactUpdateResponse	postContacts(String accountId, ContactModRequest contactModRequest) Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
ContactUpdateResponse	putContacts(String accountId, ContactModRequest contactModRequest) Replaces contacts associated with an account for the DocuSign service.
void	setApiClient(ApiClient apiClient)
CustomSettingsInformation	updateCustomSettings(String accountId, String userId, CustomSettingsInformation customSettingsInformation) Adds or updates custom user settings for the specified user.
void	updateProfile(String accountId, String userId, UserProfile userProfile) Updates the user profile information for the specified user.
void	updateProfileImage(String accountId, String userId) Updates the user profile image for a specified user.
void	updateSettings(String accountId, String userId, UserSettingsInformation userSettingsInformation) Updates the user account settings for a specified user.
UserSignature	updateSignature(String accountId, String userId, String signatureId, UserSignatureDefinition userSignatureDefinition) Updates the user signature for a specified user.
UserSignature	updateSignature(String accountId, String userId, String signatureId, UserSignatureDefinition userSignatureDefinition, UsersApi.UpdateSignatureOptions options) Updates the user signature for a specified user.
UserSignature	updateSignatureImage(String accountId, String userId, String signatureId, String imageType) Updates the user signature image or user initials image for the specified user.
UserInformation	updateUser(String accountId, String userId, UserInformation userInformation) Updates the specified user information.
UserInformationList	updateUsers(String accountId, UserInformationList userInformationList) Change one or more user in the specified account.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

putContacts

public ContactUpdateResponse putContacts(String accountId,
                                ContactModRequest contactModRequest)
                                  throws ApiException

Replaces contacts associated with an account for the DocuSign service.

Parameters:

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

UsersApi.PutContactsOptions - Options for modifying the method behavior.

Returns:

ContactUpdateResponse

Throws:

ApiException

postContacts

public ContactUpdateResponse postContacts(String accountId,
                                 ContactModRequest contactModRequest)
                                   throws ApiException

Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).

Parameters:

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

UsersApi.PostContactsOptions - Options for modifying the method behavior.

Returns:

ContactUpdateResponse

Throws:

ApiException

deleteContacts

public ContactUpdateResponse deleteContacts(String accountId,
                                   ContactModRequest contactModRequest)
                                     throws ApiException

Delete contacts associated with an account for the DocuSign service.

Parameters:

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

UsersApi.DeleteContactsOptions - Options for modifying the method behavior.

Returns:

ContactUpdateResponse

Throws:

ApiException

getContactById

public ContactGetResponse getContactById(String accountId,
                                String contactId)
                                  throws ApiException

Gets a particular contact associated with the user's account.

Parameters:

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

contactId - The unique identifier of a person in the contacts address book.

UsersApi.GetContactByIdOptions - Options for modifying the method behavior.

Returns:

ContactGetResponse

Throws:

ApiException

deleteContactWithId

public ContactUpdateResponse deleteContactWithId(String accountId,
                                        String contactId)
                                          throws ApiException

Replaces a particular contact associated with an account for the DocuSign service.

Parameters:

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

contactId - The unique identifier of a person in the contacts address book.

UsersApi.DeleteContactWithIdOptions - Options for modifying the method behavior.

Returns:

ContactUpdateResponse

Throws:

ApiException

list

public UserInformationList list(String accountId)
                         throws ApiException

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user

Parameters:

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

Returns:

UserInformationList

Throws:

ApiException

list

public UserInformationList list(String accountId,
                       UsersApi.ListOptions options)
                         throws ApiException

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user

Parameters:

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

UsersApi.ListOptions - Options for modifying the method behavior.

Returns:

UserInformationList

Throws:

ApiException

updateUsers

public UserInformationList updateUsers(String accountId,
                              UserInformationList userInformationList)
                                throws ApiException

Change one or more user in the specified account.

Parameters:

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

UsersApi.UpdateUsersOptions - Options for modifying the method behavior.

Returns:

UserInformationList

Throws:

ApiException

create

public NewUsersSummary create(String accountId,
                     NewUsersDefinition newUsersDefinition)
                       throws ApiException

Adds news user to the specified account. Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.

Parameters:

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

UsersApi.CreateOptions - Options for modifying the method behavior.

Returns:

NewUsersSummary

Throws:

ApiException

delete

public UsersResponse delete(String accountId,
                   UserInfoList userInfoList)
                     throws ApiException

Removes users account privileges. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.\n\nThe response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.

Parameters:

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

UsersApi.DeleteOptions - Options for modifying the method behavior.

Returns:

UsersResponse

Throws:

ApiException

getInformation

public UserInformation getInformation(String accountId,
                             String userId)
                               throws ApiException

Gets the user information for a specified user. Retrieves the user information for the specified user. \n\nTo return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

UserInformation

Throws:

ApiException

getInformation

public UserInformation getInformation(String accountId,
                             String userId,
                             UsersApi.GetInformationOptions options)
                               throws ApiException

Gets the user information for a specified user. Retrieves the user information for the specified user. \n\nTo return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.GetInformationOptions - Options for modifying the method behavior.

Returns:

UserInformation

Throws:

ApiException

updateUser

public UserInformation updateUser(String accountId,
                         String userId,
                         UserInformation userInformation)
                           throws ApiException

Updates the specified user information.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.UpdateUserOptions - Options for modifying the method behavior.

Returns:

UserInformation

Throws:

ApiException

listCustomSettings

public CustomSettingsInformation listCustomSettings(String accountId,
                                           String userId)
                                             throws ApiException

Retrieves the custom user settings for a specified user. Retrieves a list of custom user settings for a single user.\n\nCustom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.\n\n###### Note: Custom user settings are not the same as user account settings.\n\n###Getting Grouped Custom User Settings###\n\nIf the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are retrieved.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.ListCustomSettingsOptions - Options for modifying the method behavior.

Returns:

CustomSettingsInformation

Throws:

ApiException

updateCustomSettings

public CustomSettingsInformation updateCustomSettings(String accountId,
                                             String userId,
                                             CustomSettingsInformation customSettingsInformation)
                                               throws ApiException

Adds or updates custom user settings for the specified user. Adds or updates custom user settings for the specified user.\n\n###### Note: Custom user settings are not the same as user account settings.\n\nCustom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.\n\n**Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.\n\n### Grouping Custom User Settings ###\n\nYou can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.\n\nTo group custom user settings, add the following information in the header, after Content-Type:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.\n\nWhen getting or deleting grouped custom user settings, you must include the extra header information.\n\nGrouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.UpdateCustomSettingsOptions - Options for modifying the method behavior.

Returns:

CustomSettingsInformation

Throws:

ApiException

deleteCustomSettings

public CustomSettingsInformation deleteCustomSettings(String accountId,
                                             String userId,
                                             CustomSettingsInformation customSettingsInformation)
                                               throws ApiException

Deletes custom user settings for a specified user. Deletes the specified custom user settings for a single user.\n\n###Deleting Grouped Custom User Settings###\n\nIf the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are deleted.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.DeleteCustomSettingsOptions - Options for modifying the method behavior.

Returns:

CustomSettingsInformation

Throws:

ApiException

getProfile

public UserProfile getProfile(String accountId,
                     String userId)
                       throws ApiException

Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.GetProfileOptions - Options for modifying the method behavior.

Returns:

UserProfile

Throws:

ApiException

updateProfile

public void updateProfile(String accountId,
                 String userId,
                 UserProfile userProfile)
                   throws ApiException

Updates the user profile information for the specified user. Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.\n\nYou can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.UpdateProfileOptions - Options for modifying the method behavior.

Throws:

ApiException

getProfileImage

public byte[] getProfileImage(String accountId,
                     String userId)
                       throws ApiException

Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\n\nIf successful, the response returns a 200 - OK and the user profile image.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

byte[]

Throws:

ApiException

getProfileImage

public byte[] getProfileImage(String accountId,
                     String userId,
                     UsersApi.GetProfileImageOptions options)
                       throws ApiException

Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\n\nIf successful, the response returns a 200 - OK and the user profile image.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.GetProfileImageOptions - Options for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException

updateProfileImage

public void updateProfileImage(String accountId,
                      String userId)
                        throws ApiException

Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile.\n\nThe supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.UpdateProfileImageOptions - Options for modifying the method behavior.

Throws:

ApiException

deleteProfileImage

public void deleteProfileImage(String accountId,
                      String userId)
                        throws ApiException

Deletes the user profile image for the specified user. Deletes the user profile image from the specified user's profile.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.DeleteProfileImageOptions - Options for modifying the method behavior.

Throws:

ApiException

getSettings

public UserSettingsInformation getSettings(String accountId,
                                  String userId)
                                    throws ApiException

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user.\n\nThe response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.GetSettingsOptions - Options for modifying the method behavior.

Returns:

UserSettingsInformation

Throws:

ApiException

updateSettings

public void updateSettings(String accountId,
                  String userId,
                  UserSettingsInformation userSettingsInformation)
                    throws ApiException

Updates the user account settings for a specified user. Updates the account settings list and email notification types for the specified user.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.UpdateSettingsOptions - Options for modifying the method behavior.

Throws:

ApiException

listSignatures

public UserSignaturesInformation listSignatures(String accountId,
                                       String userId)
                                         throws ApiException

Retrieves a list of user signature definitions for a specified user. Retrieves the signature definitions for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.ListSignaturesOptions - Options for modifying the method behavior.

Returns:

UserSignaturesInformation

Throws:

ApiException

createSignatures

public UserSignaturesInformation createSignatures(String accountId,
                                         String userId,
                                         UserSignaturesInformation userSignaturesInformation)
                                           throws ApiException

Adds user Signature and initials images to a Signature. Adds a user signature image and/or user initials image to the specified user. \n\nThe userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account.\n\nThe rules and processes associated with this are:\n\n* If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.\n* If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.\n\nFor each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. \n\nFor example: \n`Content-Disposition: file; filename=\"Ron Test20121127083900\"`\n\nIf no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.\n\nThe Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.\n\nIf successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

UsersApi.CreateSignaturesOptions - Options for modifying the method behavior.

Returns:

UserSignaturesInformation

Throws:

ApiException

getSignature

public UserSignature getSignature(String accountId,
                         String userId,
                         String signatureId)
                           throws ApiException

Gets the user signature information for the specified user. Retrieves the structure of a single signature with a known signature name.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

UsersApi.GetSignatureOptions - Options for modifying the method behavior.

Returns:

UserSignature

Throws:

ApiException

updateSignature

public UserSignature updateSignature(String accountId,
                            String userId,
                            String signatureId,
                            UserSignatureDefinition userSignatureDefinition)
                              throws ApiException

Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\n\n###### Note: This will also create a default signature for the user when one does not exist.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

Returns:

UserSignature

Throws:

ApiException

updateSignature

public UserSignature updateSignature(String accountId,
                            String userId,
                            String signatureId,
                            UserSignatureDefinition userSignatureDefinition,
                            UsersApi.UpdateSignatureOptions options)
                              throws ApiException

Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\n\n###### Note: This will also create a default signature for the user when one does not exist.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

UsersApi.UpdateSignatureOptions - Options for modifying the method behavior.

Returns:

UserSignature

Throws:

ApiException

deleteSignature

public void deleteSignature(String accountId,
                   String userId,
                   String signatureId)
                     throws ApiException

Removes removes signature information for the specified user. Removes the signature information for the user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

UsersApi.DeleteSignatureOptions - Options for modifying the method behavior.

Throws:

ApiException

getSignatureImage

public byte[] getSignatureImage(String accountId,
                       String userId,
                       String signatureId,
                       String imageType)
                         throws ApiException

Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

imageType - One of **signature_image** or **initials_image**.

Returns:

byte[]

Throws:

ApiException

getSignatureImage

public byte[] getSignatureImage(String accountId,
                       String userId,
                       String signatureId,
                       String imageType,
                       UsersApi.GetSignatureImageOptions options)
                         throws ApiException

Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

imageType - One of **signature_image** or **initials_image**.

UsersApi.GetSignatureImageOptions - Options for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException

updateSignatureImage

public UserSignature updateSignatureImage(String accountId,
                                 String userId,
                                 String signatureId,
                                 String imageType)
                                   throws ApiException

Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

imageType - One of **signature_image** or **initials_image**.

UsersApi.UpdateSignatureImageOptions - Options for modifying the method behavior.

Returns:

UserSignature

Throws:

ApiException

deleteSignatureImage

public UserSignature deleteSignatureImage(String accountId,
                                 String userId,
                                 String signatureId,
                                 String imageType)
                                   throws ApiException

Deletes the user initials image or the user signature image for the specified user. Deletes the specified initials image or signature image for the specified user.\n\nThe function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

signatureId - The ID of the signature being accessed.

imageType - One of **signature_image** or **initials_image**.

UsersApi.DeleteSignatureImageOptions - Options for modifying the method behavior.

Returns:

UserSignature

Throws:

ApiException