HTTP - Management
Create a user
Created by s.yearsley, last modified by c.neale on 23 Nov 2020
Creating a user can be done by POST'ing user profile details resource to the users resource collection.
If you need to created the user with a suspended/disabled status, if you need users to validate their email addresses prior to being able to access the system for example, then you can pass an optional uri parameter of ?suspended=true. Use the unsuspend a user endpoint to allow the user to log in.
POST/api/security/users
Parameter
| Name | Parameter type | Type | Format | Description | Required |
|---|---|---|---|---|---|
| user | body | object | user | The user to create | true |
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",
"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",
"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.
Passwords must comply with the user password policy.