UserProfiles Resource

The UserProfiles resource provides methods that allow you to manage a user’s profile.

Methods supported

Method	Description
get	GET `/restapi/v2/accounts/{accountId}/users/{userId}/profile` Retrieves the user profile for a specified user.
update	PUT `/restapi/v2/accounts/{accountId}/users/{userId}/profile` Updates the user profile information for the specified user.

Property	Type	Description
`address`	addressInformation_v2
`authenticationMethods`	array	These properties cannot be modified in the PUT. Indicates the authentication methods used by the user.
`companyName`	string	The name of the user’s Company.
`displayOrganizationInfo`	string	When set to true, the user’s company and title information are shown on the ID card.
`displayPersonalInfo`	string	When set to true, the user’s Address and Phone number are shown on the ID card.
`displayProfile`	string	When set to true, the user’s ID card can be viewed from signed documents and envelope history.
`displayUsageHistory`	string	When set to true, the user’s usage information is shown on the ID card.
`profileImageUri`	string
`title`	string	The user’s job title. Limit 100 characters.
`usageHistory`	usageHistory	A complex element consisting of: lastSentDateTime - the date and time the user last sent an envelope. lastSignedDateTime - the date and time the user last signed an envelope. sentCount - the number of envelopes the user has sent. signedCount - the number of envelopes the user has signed.
`userDetails`	userInformation
`userProfileLastModifiedDate`	string	The date-time when the user’s profile was last modified.