Create User

Use this endpoint to create a new user account in the system. You must have User Management role privilege and Security Template Management role privilege in order to create a user and assign groups. This endpoint can be used to create local or federated users.

Average Response Time: 5140ms

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Request Body schema: application/json
required

The Request Body must be a JSON object

firstName
required
string [ 1 .. 50 ] characters

First Name of the User.

lastName
required
string [ 1 .. 50 ] characters

Last Name of the User.

friendlyName
required
string [ 1 .. 50 ] characters

Friendly Name of the User.

email
required
string <email> [ 6 .. 75 ] characters

Email of the User.

username
required
string <username> [ 1 .. 50 ] characters

Username of the User.

password
required
string <password> [ 8 .. 150 ] characters

Password of the User.

accountType
required
string

Account Type of the User. Local accounts use a password; Federated accounts use an SSO service.

Enum: "local" "federated"
object (UserCreateRequest_customAttributes)
userRoleId
required
string <uuid> = 36 characters

ID of the User's role. Only one role is allowed.

groups
required
Array of strings <uuid> non-empty

List of group IDs the User belongs to. At least one group is required.

isVerified
boolean

Optional flag indicating whether the user account is verified upon creation. This is only supported for customers using Auth0 authentication.

Responses
200

The Response Body is a JSON object.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

post/user
Request samples
application/json
{
  • "firstName": "John",
  • "lastName": "Wick",
  • "friendlyName": "john.wick",
  • "email": "john.wick@tenovos.com",
  • "username": "john.wick",
  • "password": "sdhg&uuUz78u",
  • "accountType": "local",
  • "customAttributes": {
    },
  • "userRoleId": "1401df5e-3f13-4c88-a5a8-de64f6227a03",
  • "groups": [
    ],
  • "isVerified": true
}
Response samples
application/json
{
  • "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  • "status": "success"
}