Create a user
Log in to add to favouritesPOST/api/security/users
Parameter
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| user(required) | body | object | user | The user to create |
Responses
Examples
Request to create a user
POST: /api/security/users
{
"username": "tdurden",
"email": "t.turden@fightclub.com",
"firstName": "Tyler",
"lastName": "Durden",
"timezone": "America/New_York",
"expiry": "2050-12-31T23:59:59.999Z",
"language": "en-US",
"custom": {
"department": "Soap sales"
},
"credentials": {
"password": "pr0j3ctM4yh3m"
}
}Request to create a user with an initial status of suspended
POST: /api/security/users?suspended=true
{
"username": "tdurden",
"email": "t.turden@fightclub.com",
"firstName": "Tyler",
"lastName": "Durden",
"timezone": "America/New_York",
"expiry": "2050-12-31T23:59:59.999Z",
"language": "en-US",
"custom": {
"department": "Soap sales"
},
"credentials": {
"password": "pr0j3ctM4yh3m"
}
}Request to create a user with an initial status of password reset required
POST: /api/security/users?forcePasswordReset=true
{
"username": "tdurden",
"email": "t.turden@fightclub.com",
"firstName": "Tyler",
"lastName": "Durden",
"timezone": "America/New_York",
"expiry": "2050-12-31T23:59:59.999Z",
"language": "en-US",
"custom": {
"department": "Soap sales"
},
"credentials": {
"password": "pr0j3ctM4yh3m"
}
}Remarks
If a username is not provided then the email will be used as the username.
Expiry must be a future date. If an expiry date is not provided then no value will be set on the user and the user account will never expire.
Passwords must comply with the user password policy.
Permissions
Member of System Administrators.