Create a new User in system.

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.

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
string

First Name of the User.

lastName
string

Last Name of the User.

friendlyName
string

Friendly Name of the User.

email
string

Email of the User.

username
string

Username of the User.

password
string

Password of the User.

accountType
string

Account Type of the User.

Enum: "local" "federated"
object (UserCreateRequest_customAttributes)
userRoleId
string

Account Type of the User.

groups
Array of strings <uuid>

List of group IDs that user belongs to

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": [
    ]
}
Response samples
application/json
{
  • "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  • "status": "success"
}