Skip to content

Latest commit

 

History

History
50 lines (46 loc) · 5.25 KB

Users.md

File metadata and controls

50 lines (46 loc) · 5.25 KB

Users

Properties

Name Type Description Notes
activationAccessCode String The activation code a new user must enter when activating their account. [optional]
company String The name of the user's company. [optional]
connectConfigurations [ConnectUserObject] Object representing the user's custom Connect configuration. [optional]
countryCode String The three-letter code for the user's country. [optional]
createdDateTime String The UTC DateTime when the item was created. [optional]
customSettings [NameValue] The name/value pair information for the user custom setting. [optional]
defaultAccountId String The default account ID associated with the user. [optional]
email String The user's email address. [optional]
enableConnectForUser String Boolean value that specifies whether the user is enabled for updates from DocuSign Connect. [optional]
errorDetails ErrorDetails [optional]
firstName String The user's first name. Maximum Length: 50 characters. [optional]
forgottenPasswordInfo ForgottenPasswordInformation [optional]
groupList [Group] A list of the group information for groups to add the user to. Use UserGroups::listGroups to get information about groups. When setting a user's group, only the `groupId` is required. [optional]
homeAddress AddressInformation [optional]
initialsImageUri String The URI for retrieving the image of the user's initials. [optional]
isAdmin String Determines if the feature set is actively set as part of the plan. [optional]
isNAREnabled String When set to true, National Association of Realtors (NAR) signature logos are enabled for the user. [optional]
lastLogin String The date and time when the user last logged in to the system. [optional]
lastName String The user's last name. Maximum Length: 50 characters. [optional]
loginStatus String Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed [optional]
middleName String The user's middle name. Limit: 50 characters. [optional]
password String The user's password. [optional]
passwordExpiration String If password expiration is enabled, the date-time when the user's password expires. [optional]
permissionProfileId String The id of the permission profile associated with the user. [optional]
permissionProfileName String The name of the permission profile associated with the user. [optional]
profileImageUri String The URL for retrieving the user's profile image. [optional]
sendActivationEmail String When set to true, specifies that an activation email be sent to the user. [optional]
sendActivationOnInvalidLogin String When set to true, specifies that an additional activation email be sent if user's log on fails before the account is activated. [optional]
signatureImageUri String An endpoint URI that you can use to retrieve the user's signature image. [optional]
subscribe String [optional]
suffixName String The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters. [optional]
title String The salutation for the user, such as Ms, Dr, Capt., etc. Limit: 10 characters. [optional]
uri String A URI containing the user ID. [optional]
userAddedToAccountDateTime String The date and time that the user was added to the account. [optional]
userId String The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. [optional]
userName String The user's full name. <!-- `title` + `firstName` + `middleName` + `lastName` + `suffixName` --> [optional]
userProfileLastModifiedDate String The date and time that the user's profile was last modified. [optional]
userSettings UserSettingsInformation [optional]
userStatus String Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` [optional]
userType String The type of user, for example `CompanyUser`. [optional]
workAddress AddressInformation [optional]

[Back to Model list] [Back to API list] [Back to README]