UserProfiles
Retrieves user profile information for a specified user.
View Specific Information
The add-in will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in.
- UserId supports the '='.
For example, the following queries are processed server side:
SELECT * FROM UserProfiles WHERE UserId = '764c564c-b540-42d1-a667-ccee6813ef7b'
Columns
| Name | Type | References | Description |
| UserId [KEY] | String | The user ID. | |
| DisplayProfile | String | Indicates whether the profile is displayed. | |
| DisplayOrganizationInfo | String | Indicates whether organization info is displayed. | |
| DisplayPersonalInfo | String | Indicates whether personal info is displayed. | |
| DisplayUsageHistory | String | Indicates whether usage history is displayed. | |
| CompanyName | String | The company name. | |
| Title | String | The title. | |
| ProfileImageUri | String | URI of the profile image. | |
| UserProfileLastModifiedDate | Date | Date when the user profile was last modified. | |
| UserName | String | The user name. | |
| UserType | String | The type of user. | |
| IsAdmin | Boolean | Whether the user is an admin. | |
| UserStatus | String | The status of the user. | |
| Uri | String | The URI of the user. | |
| String | The email address of the user. | ||
| Password | String | The password of the user. | |
| UserDetailsTitle | String | The title from user details. | |
| CreatedDateTime | Datetime | Date and time the user was created. | |
| FirstName | String | The first name of the user. | |
| MiddleName | String | The middle name of the user. | |
| LastName | String | The last name of the user. | |
| SuffixName | String | The suffix name of the user. | |
| PermissionProfileId | String | The permission profile ID. | |
| PermissionProfileName | String | The permission profile name. | |
| CountryCode | String | The country code. | |
| Subscribe | String | The subscribe setting. | |
| SendActivationOnInvalidLogin | Boolean | Whether to send activation on invalid login. | |
| ActivationAccessCode | String | The activation access code. | |
| EnableConnectForUser | String | Whether Connect is enabled for the user. | |
| LoginStatus | String | The login status of the user. | |
| PasswordExpiration | Date | The password expiration date. | |
| LastLogin | Datetime | The last login date. | |
| SendActivationEmail | Boolean | Whether to send activation email. | |
| UserDetailsProfileImageUri | String | URI of the user details profile image. | |
| UserDetailsUserProfileLastModifiedDate | Datetime | Date when user details profile was last modified. | |
| SignatureImageUri | String | URI of the signature image. | |
| InitialsImageUri | String | URI of the initials image. | |
| JobTitle | String | The job title of the user. | |
| CanManageUsers | Boolean | Whether the user can manage users. | |
| CanManageUsersMetadataRights | Boolean | Whether the user has rights to manage users. | |
| CanManageUsersMetadataUiHint | Boolean | Whether a UI hint is shown for the manage users permission. | |
| CanManageUsersMetadataUiType | Boolean | Whether the UI type is configured for the manage users permission. | |
| CanManageUsersMetadataUiOrder | Boolean | Whether the UI order is set for the manage users permission. | |
| CanManageUsersMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage users permission. | |
| CanManageUsersMetadataOptions | String | The allowed options for the manage users permission. | |
| CanManageAdmins | Boolean | Whether the user can manage admins. | |
| CanManageAdminsMetadataRights | Boolean | Whether the user has rights to manage admins. | |
| CanManageAdminsMetadataUiHint | Boolean | Whether a UI hint is shown for the manage admins permission. | |
| CanManageAdminsMetadataUiType | Boolean | Whether the UI type is configured for the manage admins permission. | |
| CanManageAdminsMetadataUiOrder | Boolean | Whether the UI order is set for the manage admins permission. | |
| CanManageAdminsMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage admins permission. | |
| CanManageAdminsMetadataOptions | String | The allowed options for the manage admins permission. | |
| CanManageGroups | Boolean | Whether the user can manage groups. | |
| CanManageGroupsMetadataRights | Boolean | Whether the user has rights to manage groups. | |
| CanManageGroupsMetadataUiHint | Boolean | Whether a UI hint is shown for the manage groups permission. | |
| CanManageGroupsMetadataUiType | Boolean | Whether the UI type is configured for the manage groups permission. | |
| CanManageGroupsMetadataUiOrder | Boolean | Whether the UI order is set for the manage groups permission. | |
| CanManageGroupsMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage groups permission. | |
| CanManageGroupsMetadataOptions | String | The allowed options for the manage groups permission. | |
| CanManageSharing | Boolean | Whether the user can manage sharing. | |
| CanManageSharingMetadataRights | Boolean | Whether the user has rights to manage sharing. | |
| CanManageSharingMetadataUiHint | Boolean | Whether a UI hint is shown for the manage sharing permission. | |
| CanManageSharingMetadataUiType | Boolean | Whether the UI type is configured for the manage sharing permission. | |
| CanManageSharingMetadataUiOrder | Boolean | Whether the UI order is set for the manage sharing permission. | |
| CanManageSharingMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage sharing permission. | |
| CanManageSharingMetadataOptions | String | The allowed options for the manage sharing permission. | |
| CanManageEnvelopeTransfer | Boolean | Whether the user can manage envelope transfer. | |
| CanManageEnvelopeTransferMetadataRights | Boolean | Whether the user has rights to manage envelope transfer. | |
| CanManageEnvelopeTransferMetadataUiHint | Boolean | Whether a UI hint is shown for the manage envelope transfer permission. | |
| CanManageEnvelopeTransferMetadataUiType | Boolean | Whether the UI type is configured for the manage envelope transfer permission. | |
| CanManageEnvelopeTransferMetadataUiOrder | Boolean | Whether the UI order is set for the manage envelope transfer permission. | |
| CanManageEnvelopeTransferMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage envelope transfer permission. | |
| CanManageEnvelopeTransferMetadataOptions | String | The allowed options for the manage envelope transfer permission. | |
| CanManageAccountSettings | Boolean | Whether the user can manage account settings. | |
| CanManageAccountSettingsMetadataRights | Boolean | Whether the user has rights to manage account settings. | |
| CanManageAccountSettingsMetadataUiHint | Boolean | Whether a UI hint is shown for the manage account settings permission. | |
| CanManageAccountSettingsMetadataUiType | Boolean | Whether the UI type is configured for the manage account settings permission. | |
| CanManageAccountSettingsMetadataUiOrder | Boolean | Whether the UI order is set for the manage account settings permission. | |
| CanManageAccountSettingsMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage account settings permission. | |
| CanManageAccountSettingsMetadataOptions | String | The allowed options for the manage account settings permission. | |
| CanManageReporting | Boolean | Whether the user can manage reporting. | |
| CanManageReportingMetadataRights | Boolean | Whether the user has rights to manage reporting. | |
| CanManageReportingMetadataUiHint | Boolean | Whether a UI hint is shown for the manage reporting permission. | |
| CanManageReportingMetadataUiType | Boolean | Whether the UI type is configured for the manage reporting permission. | |
| CanManageReportingMetadataUiOrder | Boolean | Whether the UI order is set for the manage reporting permission. | |
| CanManageReportingMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage reporting permission. | |
| CanManageReportingMetadataOptions | String | The allowed options for the manage reporting permission. | |
| CanManageAccountSecuritySettings | Boolean | Whether the user can manage account security settings. | |
| CanManageAccountSecuritySettingsMetadataRights | Boolean | Whether the user has rights to manage account security settings. | |
| CanManageAccountSecuritySettingsMetadataUiHint | Boolean | Whether a UI hint is shown for the manage account security settings permission. | |
| CanManageAccountSecuritySettingsMetadataUiType | Boolean | Whether the UI type is configured for the manage account security settings permission. | |
| CanManageAccountSecuritySettingsMetadataUiOrder | Boolean | Whether the UI order is set for the manage account security settings permission. | |
| CanManageAccountSecuritySettingsMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage account security settings permission. | |
| CanManageAccountSecuritySettingsMetadataOptions | String | The allowed options for the manage account security settings permission. | |
| CanManageSigningGroups | Boolean | Whether the user can manage signing groups. | |
| CanManageSigningGroupsMetadataRights | Boolean | Whether the user has rights to manage signing groups. | |
| CanManageSigningGroupsMetadataUiHint | Boolean | Whether a UI hint is shown for the manage signing groups permission. | |
| CanManageSigningGroupsMetadataUiType | Boolean | Whether the UI type is configured for the manage signing groups permission. | |
| CanManageSigningGroupsMetadataUiOrder | Boolean | Whether the UI order is set for the manage signing groups permission. | |
| CanManageSigningGroupsMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage signing groups permission. | |
| CanManageSigningGroupsMetadataOptions | String | The allowed options for the manage signing groups permission. | |
| CanManageDocumentRetention | Boolean | Whether the user can manage document retention. | |
| CanManageDocumentRetentionMetadataRights | Boolean | Whether the user has rights to manage document retention. | |
| CanManageDocumentRetentionMetadataUiHint | Boolean | Whether a UI hint is shown for the manage document retention permission. | |
| CanManageDocumentRetentionMetadataUiType | Boolean | Whether the UI type is configured for the manage document retention permission. | |
| CanManageDocumentRetentionMetadataUiOrder | Boolean | Whether the UI order is set for the manage document retention permission. | |
| CanManageDocumentRetentionMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage document retention permission. | |
| CanManageDocumentRetentionMetadataOptions | String | The allowed options for the manage document retention permission. | |
| CanManageConnect | Boolean | Whether the user can manage Connect. | |
| CanManageConnectMetadataRights | Boolean | Whether the user has rights to manage Connect. | |
| CanManageConnectMetadataUiHint | Boolean | Whether a UI hint is shown for the manage Connect permission. | |
| CanManageConnectMetadataUiType | Boolean | Whether the UI type is configured for the manage Connect permission. | |
| CanManageConnectMetadataUiOrder | Boolean | Whether the UI order is set for the manage Connect permission. | |
| CanManageConnectMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the manage Connect permission. | |
| CanManageConnectMetadataOptions | String | The allowed options for the manage Connect permission. | |
| CanViewUsers | Boolean | Whether the user can view users. | |
| CanViewUsersMetadataRights | Boolean | Whether the user has rights to view users. | |
| CanViewUsersMetadataUiHint | Boolean | Whether a UI hint is shown for the view users permission. | |
| CanViewUsersMetadataUiType | Boolean | Whether the UI type is configured for the view users permission. | |
| CanViewUsersMetadataUiOrder | Boolean | Whether the UI order is set for the view users permission. | |
| CanViewUsersMetadataIs21CFRPart11 | Boolean | Whether 21 CFR Part 11 applies to the view users permission. | |
| CanViewUsersMetadataOptions | String | The allowed options for the view users permission. | |
| ForgottenPasswordQuestion1 | String | Forgotten password question 1. | |
| ForgottenPasswordAnswer1 | String | Forgotten password answer 1. | |
| ForgottenPasswordQuestion2 | String | Forgotten password question 2. | |
| ForgottenPasswordAnswer2 | String | Forgotten password answer 2. | |
| ForgottenPasswordQuestion3 | String | Forgotten password question 3. | |
| ForgottenPasswordAnswer3 | String | Forgotten password answer 3. | |
| ForgottenPasswordQuestion4 | String | Forgotten password question 4. | |
| ForgottenPasswordAnswer4 | String | Forgotten password answer 4. | |
| WorkAddress1 | String | Work address line 1. | |
| WorkAddress2 | String | Work address line 2. | |
| WorkCity | String | Work city. | |
| WorkStateOrProvince | String | Work state or province. | |
| WorkPostalCode | String | Work postal code. | |
| WorkPhone | String | Work phone number. | |
| WorkFax | String | Work fax number. | |
| WorkCountry | String | Work country. | |
| HomeAddress1 | String | Home address line 1. | |
| HomeAddress2 | String | Home address line 2. | |
| HomeCity | String | Home city. | |
| HomeStateOrProvince | String | Home state or province. | |
| HomePostalCode | String | Home postal code. | |
| HomePhone | String | Home phone number. | |
| HomeFax | String | Home fax number. | |
| HomeCountry | String | Home country. | |
| UserSettings | String | The user settings. | |
| GroupList | String | The list of groups the user belongs to. | |
| CustomSettings | String | The custom settings for the user. | |
| Address1 | String | Address line 1. | |
| Address2 | String | Address line 2. | |
| City | String | City. | |
| StateOrProvince | String | State or province. | |
| PostalCode | String | Postal code. | |
| ZipPlus4 | String | ZIP4 code. | |
| Phone | String | Phone number. | |
| Fax | String | Fax number. | |
| Country | String | Country. | |
| AuthenticationMethods | String | The authentication methods for the user. | |
| SignedCount | Int | Number of documents signed. | |
| LastSignedDateTime | Datetime | Date and time of last signing. | |
| SentCount | Int | Number of documents sent. | |
| LastSentDateTime | Datetime | Date and time of last send. |