Request parameters
Parameter Name | Description | Required |
account | Creates the user under the specified account. If no account is specified, the username will be used as the account name. | true |
domainid | Creates the user under the specified domain. Has to be accompanied with the account parameter | true |
true | ||
firstname | firstname | true |
lastname | lastname | true |
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 See Docs section. | true |
username | Unique username. | true |
timezone | Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format. | false |
userid | User UUID, required for adding account from external provisioning system | 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 |
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 |
secretkey | the secret key of the user |
state | the user state |
timezone | the timezone user was created in |
username | the user name |