Request parameters
| Parameter Name | Description | Required |
| id | User uuid | true |
| currentpassword | Current password that was being used by the user. You must inform the current password when updating the password. | false |
| false | ||
| firstname | first name | false |
| lastname | last name | false |
| mandate2fa | Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA | false |
| password | Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port | false |
| timezone | Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. | false |
| userapikey | The API key for the user. Must be specified with userSecretKey | false |
| username | Unique username | false |
| usersecretkey | The secret key for the user. Must be specified with userApiKey | false |
Response Tags
| Response Name | Description |
| id | the user ID |
| account | the account name of the user |
| accountid | the account ID of the user |
| accounttype | the account type of the user |
| apikey | the api key of the user |
| created | the date and time the user account was created |
| domain | the domain name of the user |
| domainid | the domain ID of the user |
| the user email address | |
| firstname | the user firstname |
| icon | Base64 string representation of the resource icon |
| is2faenabled | true if user has two factor authentication enabled |
| is2famandated | true if user has two factor authentication is mandated |
| iscallerchilddomain | the boolean value representing if the updating target is in caller's child domain |
| isdefault | true if user is default, false otherwise |
| lastname | the user lastname |
| roleid | the ID of the role |
| rolename | the name of the role |
| roletype | the type of the role |
| secretkey | the secret key of the user |
| state | the user state |
| timezone | the timezone user was created in |
| username | the user name |
| usersource | the source type of the user in lowercase, such as native, ldap, saml2 |