DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

Users Resource

The Users resource provides methods that allow you to manage users for an account.

MethodDescription
list
GET /v2/accounts/{accountId}/users

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

updateList
PUT /v2/accounts/{accountId}/users

create
POST /v2/accounts/{accountId}/users

Adds new users to an account.

The body of this request is an array of Users objects. For each new user, you must provide at least the userName and an email.

The userSettings property is a name/value 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.

{
  "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:
  • none
  • use_only_shared
  • use_private_and_shared
  • share
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:
  • none
  • use
  • create
  • share
canSendAPIRequests Boolean Admin & account setting 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:
  • Chinese Simplified: zh_CN
  • Chinese Traditional: zh_TW
  • Dutch: nl
  • English US: en
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Portuguese: pt
  • Portuguese (Brazil): pt_BR
  • Russian: ru
  • Spanish: es
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 selfSignedRecipientEmailDocumentUserOverride account setting is true. This setting overrides the account setting. Possibe values are:
  • include_pdf: A PDF of the completed document is attached to the email.
  • include_link: A secure link to the self-signed documents is included in the email.
vaultingMode String Admin Sets the electronic vaulting mode for the user. Possible values:
  • none
  • estored
  • electronic_original

delete
DELETE /v2/accounts/{accountId}/users

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.

get
GET /v2/accounts/{accountId}/users/{userId}

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.

update
PUT /v2/accounts/{accountId}/users/{userId}

getProfileImage
GET /v2/accounts/{accountId}/users/{userId}/profile/image

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.

updateProfileImage
PUT /v2/accounts/{accountId}/users/{userId}/profile/image

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.

deleteProfileImage
DELETE /v2/accounts/{accountId}/users/{userId}/profile/image

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.

getSettings
GET /v2/accounts/{accountId}/users/{userId}/settings

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

updateSettings
PUT /v2/accounts/{accountId}/users/{userId}/settings

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