Request parameters
| Parameter Name | Description | Required |
| id | User uuid | true |
| apikeyaccess | Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account | false |
| 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 |
| passwordchangerequired | Provide true to mandate the User to reset password on next login. | false |
| timezone | Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. | false |
| userapikey | Updates the latest API key of the user. Must be specified with usersecretkey | false |
| username | Unique username | false |
| usersecretkey | Updates the latest secret key of 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 |
| apikeyaccess | Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent) |
| 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 |