Users
Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint
Retrieves the user information for the specified user. For example:
{ "userName": "Tania Morales", "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163", "userType": "CompanyUser", "isAdmin": "False", "isNAREnabled": "false", "userStatus": "Active", "uri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163", "email": "examplename42@orobia.net", "createdDateTime": "2019-04-01T22:11:56.4570000Z", "userAddedToAccountDateTime": "0001-01-01T08:00:00.0000000Z", "firstName": "Tania", "lastName": "Morales", "jobTitle": "", "company": "Company", "permissionProfileId": "12345678", "permissionProfileName": "DocuSign Viewer", "userSettings": {. . .}, "sendActivationOnInvalidLogin": "false", "enableConnectForUser": "false", "groupList": [. . .], "workAddress": {. . .}, "homeAddress": {. . .}, "signatureImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image", "initialsImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image", "defaultAccountId": "f636f297-xxxx-xxxx-xxxx-8e7a14715950"}Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
userId*string
The ID of the user to access.
Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
Query Parameters
additional_info?string
Setting this parameter has no effect in this operation.
email?string
Setting this parameter has no effect in this operation.
include_license?string
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/users/string"{ "activationAccessCode": "string", "company": "string", "connectConfigurations": [ { "configurationtype": "string", "connectId": "string", "enabled": "string", "hasAccess": "string", "senderSearchableItems": [ "string" ] } ], "countryCode": "string", "createdDateTime": "string", "customSettings": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "name": "string", "originalValue": "string", "value": "string" } ], "defaultAccountId": "string", "email": "string", "enableConnectForUser": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "firstName": "string", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "string", "forgottenPasswordAnswer2": "string", "forgottenPasswordAnswer3": "string", "forgottenPasswordAnswer4": "string", "forgottenPasswordQuestion1": "string", "forgottenPasswordQuestion2": "string", "forgottenPasswordQuestion3": "string", "forgottenPasswordQuestion4": "string" }, "groupList": [ { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" } ], "hasRemoteNotary": true, "homeAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "initialsImageUri": "string", "isAdmin": "string", "isAlternateAdmin": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "isNAREnabled": "string", "jobTitle": "string", "lastLogin": "string", "lastName": "string", "licenseStatus": "string", "licenseType": "string", "loginStatus": "string", "middleName": "string", "password": "string", "passwordExpiration": "string", "permissionProfileId": "string", "permissionProfileName": "string", "profileImageUri": "string", "sendActivationEmail": "string", "sendActivationOnInvalidLogin": "string", "signatureImageUri": "string", "subscribe": "string", "suffixName": "string", "title": "string", "uri": "string", "userAddedToAccountDateTime": "string", "userId": "string", "userName": "string", "userProfileLastModifiedDate": "string", "userSettings": { "accountAgreementsAccessType": "string", "accountManagementGranular": { "canManageAccountSecuritySettings": "string", "canManageAccountSettings": "string", "canManageAdmins": "string", "canManageConnect": "string", "canManageDocumentRetention": "string", "canManageEnvelopeTransfer": "string", "canManageGroupsButNotUsers": "string", "canManageJointAgreements": "string", "canManageReporting": "string", "canManageSharing": "string", "canManageSigningGroups": "string", "canManageStamps": "string", "canManageUsers": "string", "canViewUsers": "string" }, "adminOnly": "string", "allowAccessToAllAccountAgreements": "string", "allowAutoTagging": "string", "allowedDocumentTemplateLibraryAccess": "string", "allowedOrchestrationAccess": "string", "allowEnvelopeTransferTo": "string", "allowEsealRecipients": "string", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "string", "allowRecipientLanguageSelection": "string", "allowSendOnBehalfOf": "string", "allowSupplementalDocuments": "string", "allowTransactions": "string", "anchorTagVersionedPlacementEnabled": "string", "apiAccountWideAccess": "string", "apiCanExportAC": "string", "bulkSend": "string", "canBulkUploadAgreements": "string", "canChargeAccount": "string", "canCreateTransaction": "string", "canDeleteDocumentsInTransaction": "string", "canDeleteTransaction": "string", "canEditSharedAddressbook": "string", "canLockEnvelopes": "string", "canManageAccount": "string", "canManageAgreementParties": "string", "canManageDistributor": "string", "canManageTemplates": "string", "canSendAPIRequests": "string", "canSendEnvelope": "string", "canSendEnvelopesViaSMS": "string", "canSignEnvelope": "string", "canUseScratchpad": "string", "canUseSmartContracts": "string", "disableDocumentUpload": "string", "disableOtherActions": "string", "enableDSPro": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableSequentialSigningAPI": "string", "enableSequentialSigningUI": "string", "enableSignerAttachments": "string", "enableSignOnPaperOverride": "string", "enableTransactionPoint": "string", "enableVaulting": "string", "expressSendOnly": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "locale": "string", "localePolicy": { "addressFormat": "string", "allowRegion": "string", "calendarType": "string", "cultureName": "string", "currencyCode": "string", "currencyNegativeFormat": "string", "currencyPositiveFormat": "string", "customDateFormat": "string", "customSignDateFormat": "string", "customSignTimeFormat": "string", "customTimeFormat": "string", "dateFormat": "string", "effectiveAddressFormat": "string", "effectiveCalendarType": "string", "effectiveCurrencyCode": "string", "effectiveCurrencyNegativeFormat": "string", "effectiveCurrencyPositiveFormat": "string", "effectiveCustomDateFormat": "string", "effectiveCustomTimeFormat": "string", "effectiveDateFormat": "string", "effectiveInitialFormat": "string", "effectiveNameFormat": "string", "effectiveTimeFormat": "string", "effectiveTimeZone": "string", "initialFormat": "string", "nameFormat": "string", "signDateFormat": "string", "signTimeFormat": "string", "timeFormat": "string", "timeZone": "string" }, "manageClickwrapsMode": "string", "modifiedBy": "string", "modifiedDate": "string", "modifiedPage": "string", "newSendUI": "string", "powerFormMode": "string", "recipientViewedNotification": "string", "sealIdentifiers": [ { "sealDisplayName": "string", "sealName": "string" } ], "selfSignedRecipientEmailDocument": "string", "senderEmailNotifications": { "changedSigner": "string", "clickwrapResponsesLimitNotificationEmail": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "deliveryFailed": "string", "envelopeComplete": "string", "offlineSigningFailed": "string", "powerformResponsesLimitNotificationEmail": "string", "purgeDocuments": "string", "recipientViewed": "string", "senderEnvelopeDeclined": "string", "withdrawnConsent": "string" }, "signerEmailNotifications": { "agentNotification": "string", "carbonCopyNotification": "string", "certifiedDeliveryNotification": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "documentMarkupActivation": "string", "envelopeActivation": "string", "envelopeComplete": "string", "envelopeCorrected": "string", "envelopeDeclined": "string", "envelopeVoided": "string", "faxReceived": "string", "offlineSigningFailed": "string", "purgeDocuments": "string", "reassignedSigner": "string", "whenSigningGroupMember": "string" }, "supplementalDocumentIncludeInDownload": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "templateActiveCreation": "string", "templateApplyNotify": "string", "templateAutoMatching": "string", "templateMatchingSensitivity": "string", "templatePageLevelMatching": "string", "timezoneDST": "string", "timezoneMask": "string", "timezoneOffset": "string", "timezoneSendingPref": "string", "timezoneSigningPref": "string", "transactionPointSiteNameURL": "string", "transactionPointUserName": "string", "vaultingMode": "string", "webForms": "string" }, "userStatus": "string", "userType": "string", "workAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }}Changes one or more users in the specified account PUT
This method updates the information about one or more account users.
Updates user information for the specified user PUT
To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.