Update a User |
Updates the definition of a user.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/security/users
|
Note: The bartendercloud.com domain that is referenced in the URI must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
None.
Query Parameters
None.
Request Body Schema
Password
Type: String (or null)
Specifies the user password.
VerifyEmail
Type: Boolean (or null)
UserId
Type: String (or null)
Specifies the user's identification.
Onboarded
Type: Boolean (or null)
Company
Type: String (or null)
Specifies the user's company.
Country
Type: String (or null)
Specifies the user's country.
DisplayName
Type: String (or null)
Specifies the user's name.
City
Type: String (or null)
Specifies the user's city.
Type: String (or null)
Specifies the user's email address.
FirstName
Type: String (or null)
Specifies the user's first name.
Industry
Type: String (or null)
Specifies the user's industry.
LastName
Type: String (or null)
Specifies the user's last name.
PhoneNumber
Type: String (or null)
Specifies the user's phone number.
Picture
Type: String <byte> (or null)
Specifies the user's picture.
PictureType
Type: integer <int32>
Specifies the image type of the picture.
PositionTitle
Type: String (or null)
Specifies the user's position title.
StateProvince
Type: String (or null)
Specifies the user's state or province.
Locked
Type: Boolean (or null)
Administrator
Type: Boolean (or null)
RoleIds
Type: Array of strings (or null)
Specifies the roles to which the user is a member.