DocuSign.Api.Users (DocuSign v0.3.4) View Source

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

Gets the user information for a specified user. Retrieves the user information for the specified user. To 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.

Deletes the user profile image for the specified user. Deletes the user profile image from the specified user's profile. The 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.

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. The 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. If successful, the response returns a 200 - OK and the user profile image.

Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile. The 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.

Updates the specified user information.

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user. The 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].

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

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. The 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.

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The 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

Adds news user to the specified account. Adds new users to an account. The body of this request is an array of [`Users`][usersobject] objects. For each new user, you must provide at least the `userName` and an `email`. The `userSettings` property is a [name/value][nameValue] list that specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`. ``` POST /restapi/v2/accounts/{accountId}/users Content-Type: application/json ``` ``` { "newUsers": [ { "userName": "Claire Horace", "email": "claire@example.com.com" }, { "userName": "Tal Mason", "email": "tal@example.com.com", "userSettings": [ { "name": "canSendEnvelope", "value": "true" }, { "name": "locale", "value": "fr" } ] } ] } ``` A successful response is a `newUsers` array with information about the newly created users. If there was problem creating a user, that entry will contain an `errorDetails` property that describes what went wrong. ```json { "newUsers": [ { "userId": "e064a4fc-c0da-c0c0-95fa-8bac87ede98a", "uri": "/users/e064a4fc-c0da-c0c0-95fa-8bac87ede98a", "email": "claire@example.com", "userName": "Claire Horace", "createdDateTime": "0001-01-01T08:00:00.0000000Z", "errorDetails": { "errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT", "message": "Username and email combination already exists for this account." } }, { "userId": "a0e6c64b-feed-cafe-9af0-805ff3c8cffd", "uri": "/users/a0e6c64b-feed-cafe-9af0-805ff3c8cffd", "email": "tal@example.com", "userName": "Tal Mason", "userStatus": "ActivationSent", "createdDateTime": "2017-09-15T05:54:36.1265683Z" } ] } ``` ### User Settings User settings specify the capabilities a newly created user will have. | Name | Value | Authorization Requried | Description | | :------------------------------- | :------ | :------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | allowBulkRecipients | Boolean | Admin | When true, this user can use the bulk send functionality. | | allowRecipientLanguageSelection | Boolean | Admin | When true, this user can set the language used in the standard email format for a recipient when creating an envelope. | | allowSendOnBehalfOf | Boolean | Admin | When true, this user can send envelopes 'on behalf of' other users through the API. | | apiAccountWideAccess | Boolean | Admin | When true, this user can send and manage envelopes for the entire account using the DocuSign API. | | canEditSharedAddressBook | String | Admin | Sets the address book usage and management rights for the user. Possible values: <ul> <li><code>none</code></li> <li><code>use_only_shared</code></li> <li><code>use_private_and_shared</code></li> <li><code>share</code></li> </ul> | | canManageAccount | Boolean | Admin & not setting for self | When true, this user can manage account settings, manage user settings, add users, and remove users. | | canManageTemplates | String | Admin & not setting for self | Sets the template usage and management rights for the user. Possible values: <ul> <li><code>none</code></li> <li><code>use</code></li> <li><code>create</code></li> <li><code>share</code></li> </ul> | | canSendAPIRequests | Boolean | Admin & [account setting][accountsettings] `usesAPI` is set| Only needed if integrator key is not used. When true, this user can send and manage envelopes using the DocuSign API. | | canSendEnvelope | Boolean | Admin & not setting for self | When true, this user can send envelopes though the DocuSign Console. | | enableDSPro | Boolean | SysAdmin | When true, this user can send and manage envelopes from the DocuSign Desktop Client. | | enableSequentialSigningAPI | Boolean | SysAdmin | When true, this user can define the routing order of recipients for envelopes sent using the DocuSign API. | | enableSequentialSigningUI | Boolean | SysAdmin | When true, this user can define the routing order of recipients while sending documents for signature. | | enableSignerAttachments | Boolean | Admin | When true, this user can add requests for attachments from signers while sending documents. | | enableSignOnPaperOverride | Boolean | Admin | When true, this user can override the account setting that determines if signers may sign their documents on paper as an option to signing electronically. | | enableTransactionPoint | Boolean | SysAdmin | When true, this user can select an envelope from their member console and upload the envelope documents to TransactionPoint. | | enableVaulting | Boolean | Admin | When true, this user can use electronic vaulting for documents. | | locale | String | Admin | Sets the default language for the user. The supported languages are: <ul> <li>Chinese Simplified: <code>zh_CN</code></li> <li>Chinese Traditional: <code>zh_TW</code></li> <li>Dutch: <code>nl</code></li> <li>English US: <code>en</code></li> <li>French: <code>fr</code></li> <li>German: <code>de</code></li> <li>Italian: <code>it</code></li> <li>Japanese: <code>ja</code></li> <li>Korean: <code>ko</code></li> <li>Portuguese: <code>pt</code></li> <li>Portuguese (Brazil): <code>pt_BR</code></li> <li>Russian: <code>ru</code></li> <li>Spanish: <code>es</code></li> </ul> | | powerFormAdmin | Boolean | Admin | When true, this user can create, manage and download the PowerForms documents. | | powerFormUser | Boolean | Admin | When true, this user can view and download PowerForms documents. | | selfSignedRecipientEmailDocument | String | Admin | Sets how self-signed documents are presented to the email recipients. This can only be changed if the <code>selfSignedRecipientEmailDocumentUserOverride</code> <a href="/esign/restapi/Accounts/Accounts/create/#account-settings">account setting</a> is <strong>true</strong>. This setting overrides the account setting. Possibe values are: <ul> <li><code>include_pdf</code>: A PDF of the completed document is attached to the email.</li> <li><code>include_link</code>: A secure link to the self-signed documents is included in the email.</li> </ul> | | vaultingMode | String | Admin | Sets the electronic vaulting mode for the user. Possible values: <ul> <li><code>none</code></li> <li><code>estored</code></li> <li><code>electronic_original</code></li> </ul> | [accountsettings]: /esign/restapi/Accounts/Accounts/create/#account-settings [nameValue]: #/definitions/nameValue [usersobject]: #/definitions/Users

Change one or more user in the specified account.

Link to this section Functions

Link to this function

user_get_user(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_get_user(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Users.t()} | {:error, Tesla.Env.t()}

Gets the user information for a specified user. Retrieves the user information for the specified user. To 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :additional_info (String.t): When set to true, the full list of user information is returned for each user in the account.
    • :email (String.t):

Returns

} on success {:error, info} on failure

Link to this function

user_profile_image_delete_user_profile_image(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_profile_image_delete_user_profile_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes the user profile image for the specified user. Deletes the user profile image from the specified user's profile. The 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

user_profile_image_get_user_profile_image(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_profile_image_get_user_profile_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

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. The 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. If successful, the response returns a 200 - OK and the user profile image.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :encoding (String.t):

Returns

} on success {:error, info} on failure

Link to this function

user_profile_image_put_user_profile_image(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_profile_image_put_user_profile_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile. The 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

user_put_user(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_put_user(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Users.t()} | {:error, Tesla.Env.t()}

Updates the specified user information.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :users (Users):

Returns

} on success {:error, info} on failure

Link to this function

user_settings_get_user_settings(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_settings_get_user_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.UserSettingsInformation.t()} | {:error, Tesla.Env.t()}

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user. The 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

user_settings_put_user_settings(connection, account_id, user_id, opts \\ [])

View Source

Specs

user_settings_put_user_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :user_settings_information (UserSettingsInformation):

Returns

} on success {:error, info} on failure

Link to this function

users_delete_users(connection, account_id, opts \\ [])

View Source

Specs

users_delete_users(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.GroupUsers.t()} | {:error, Tesla.Env.t()}

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. The 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :delete (String.t):
    • :user_info_list (UserInfoList):

Returns

} on success {:error, info} on failure

Link to this function

users_get_users(connection, account_id, opts \\ [])

View Source

Specs

users_get_users(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.UserInformationList.t()} | {:error, Tesla.Env.t()}

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The 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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :additional_info (String.t): When set to true, the full list of user information is returned for each user in the account.
    • :count (String.t): Number of records to return. The number must be greater than 0 and less than or equal to 100.
    • :email (String.t):
    • :email_substring (String.t): Filters the returned user records by the email address or a sub-string of email address.
    • :group_id (String.t): Filters user records returned by one or more group Id's.
    • :login_status (String.t):
    • :not_group_id (String.t):
    • :start_position (String.t): Starting value for the list.
    • :status (String.t): Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. * voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
    • :user_name_substring (String.t): Filters the user records returned by the user name or a sub-string of user name.

Returns

} on success {:error, info} on failure

Link to this function

users_post_users(connection, account_id, opts \\ [])

View Source

Specs

users_post_users(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.NewUsersSummary.t()} | {:error, Tesla.Env.t()}

Adds news user to the specified account. Adds new users to an account. The body of this request is an array of [`Users`][usersobject] objects. For each new user, you must provide at least the `userName` and an `email`. The `userSettings` property is a [name/value][nameValue] list that specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`. ``` POST /restapi/v2/accounts/{accountId}/users Content-Type: application/json ``` ``` { "newUsers": [ { "userName": "Claire Horace", "email": "claire@example.com.com" }, { "userName": "Tal Mason", "email": "tal@example.com.com", "userSettings": [ { "name": "canSendEnvelope", "value": "true" }, { "name": "locale", "value": "fr" } ] } ] } ``` A successful response is a `newUsers` array with information about the newly created users. If there was problem creating a user, that entry will contain an `errorDetails` property that describes what went wrong. ```json { "newUsers": [ { "userId": "e064a4fc-c0da-c0c0-95fa-8bac87ede98a", "uri": "/users/e064a4fc-c0da-c0c0-95fa-8bac87ede98a", "email": "claire@example.com", "userName": "Claire Horace", "createdDateTime": "0001-01-01T08:00:00.0000000Z", "errorDetails": { "errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT", "message": "Username and email combination already exists for this account." } }, { "userId": "a0e6c64b-feed-cafe-9af0-805ff3c8cffd", "uri": "/users/a0e6c64b-feed-cafe-9af0-805ff3c8cffd", "email": "tal@example.com", "userName": "Tal Mason", "userStatus": "ActivationSent", "createdDateTime": "2017-09-15T05:54:36.1265683Z" } ] } ``` ### User Settings User settings specify the capabilities a newly created user will have. | Name | Value | Authorization Requried | Description | | :------------------------------- | :------ | :------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | allowBulkRecipients | Boolean | Admin | When true, this user can use the bulk send functionality. | | allowRecipientLanguageSelection | Boolean | Admin | When true, this user can set the language used in the standard email format for a recipient when creating an envelope. | | allowSendOnBehalfOf | Boolean | Admin | When true, this user can send envelopes 'on behalf of' other users through the API. | | apiAccountWideAccess | Boolean | Admin | When true, this user can send and manage envelopes for the entire account using the DocuSign API. | | canEditSharedAddressBook | String | Admin | Sets the address book usage and management rights for the user. Possible values: <ul> <li><code>none</code></li> <li><code>use_only_shared</code></li> <li><code>use_private_and_shared</code></li> <li><code>share</code></li> </ul> | | canManageAccount | Boolean | Admin & not setting for self | When true, this user can manage account settings, manage user settings, add users, and remove users. | | canManageTemplates | String | Admin & not setting for self | Sets the template usage and management rights for the user. Possible values: <ul> <li><code>none</code></li> <li><code>use</code></li> <li><code>create</code></li> <li><code>share</code></li> </ul> | | canSendAPIRequests | Boolean | Admin & [account setting][accountsettings] `usesAPI` is set| Only needed if integrator key is not used. When true, this user can send and manage envelopes using the DocuSign API. | | canSendEnvelope | Boolean | Admin & not setting for self | When true, this user can send envelopes though the DocuSign Console. | | enableDSPro | Boolean | SysAdmin | When true, this user can send and manage envelopes from the DocuSign Desktop Client. | | enableSequentialSigningAPI | Boolean | SysAdmin | When true, this user can define the routing order of recipients for envelopes sent using the DocuSign API. | | enableSequentialSigningUI | Boolean | SysAdmin | When true, this user can define the routing order of recipients while sending documents for signature. | | enableSignerAttachments | Boolean | Admin | When true, this user can add requests for attachments from signers while sending documents. | | enableSignOnPaperOverride | Boolean | Admin | When true, this user can override the account setting that determines if signers may sign their documents on paper as an option to signing electronically. | | enableTransactionPoint | Boolean | SysAdmin | When true, this user can select an envelope from their member console and upload the envelope documents to TransactionPoint. | | enableVaulting | Boolean | Admin | When true, this user can use electronic vaulting for documents. | | locale | String | Admin | Sets the default language for the user. The supported languages are: <ul> <li>Chinese Simplified: <code>zh_CN</code></li> <li>Chinese Traditional: <code>zh_TW</code></li> <li>Dutch: <code>nl</code></li> <li>English US: <code>en</code></li> <li>French: <code>fr</code></li> <li>German: <code>de</code></li> <li>Italian: <code>it</code></li> <li>Japanese: <code>ja</code></li> <li>Korean: <code>ko</code></li> <li>Portuguese: <code>pt</code></li> <li>Portuguese (Brazil): <code>pt_BR</code></li> <li>Russian: <code>ru</code></li> <li>Spanish: <code>es</code></li> </ul> | | powerFormAdmin | Boolean | Admin | When true, this user can create, manage and download the PowerForms documents. | | powerFormUser | Boolean | Admin | When true, this user can view and download PowerForms documents. | | selfSignedRecipientEmailDocument | String | Admin | Sets how self-signed documents are presented to the email recipients. This can only be changed if the <code>selfSignedRecipientEmailDocumentUserOverride</code> <a href="/esign/restapi/Accounts/Accounts/create/#account-settings">account setting</a> is <strong>true</strong>. This setting overrides the account setting. Possibe values are: <ul> <li><code>include_pdf</code>: A PDF of the completed document is attached to the email.</li> <li><code>include_link</code>: A secure link to the self-signed documents is included in the email.</li> </ul> | | vaultingMode | String | Admin | Sets the electronic vaulting mode for the user. Possible values: <ul> <li><code>none</code></li> <li><code>estored</code></li> <li><code>electronic_original</code></li> </ul> | [accountsettings]: /esign/restapi/Accounts/Accounts/create/#account-settings [nameValue]: #/definitions/nameValue [usersobject]: #/definitions/Users

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :new_users_definition (NewUsersDefinition):

Returns

} on success {:error, info} on failure

Link to this function

users_put_users(connection, account_id, opts \\ [])

View Source

Specs

users_put_users(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.UserInformationList.t()} | {:error, Tesla.Env.t()}

Change one or more user in the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :user_information_list (UserInformationList):

Returns

} on success {:error, info} on failure