v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Users

Create a new user

Creates a new user.

To enable the user to access an account, they must be assigned at least one role. A user will not be sent an email invite until assigned at least one role.

Follow these steps to create and configure a user:

Create user: Create the user by calling POST /users.
Get role(s): Use GET /roles to fetch the role_identifier(s) you wish to assign to the user.
(Optional) Get account: If you need to assign roles for an account you're not currently logged into but within the same organization, retrieve the relevant account_identifier using GET clients/me/accounts.
Assign user role: Use POST /users/{user_identifier}/roles to assign the user to an account with a list of role_identifier(s) and optionally the account_identifier if applicable.

You need the "Create and update users" permission to use this endpoint.

post/v2/users

Request body

emailstring email required

Email address of the user.

namestring required

Full name of the user.

Example request

{
  "email": "john@example.com",
  "name": "John Doe"
}

Response

CREATED

activeboolean required

If a user is active or deactivated.

client_identifierstring uuid required

The unique identifier of the client.

created_atstring date-time required

Date and time the user was created.

created_bystring uuid required

The unique identifier of who created the user.

deactivated_atstring date-time

Date and time the user was deactivated.

emailstring required

Email address of the user.

enforce_mfa_afterstring date-time

Date and time of when MFA will be enforced for the user.

identifierstring uuid required

The unique identifier of the user.

namestring required

Full name of the user.

updated_atstring date-time required

Date and time the user was last updated.

updated_bystring uuid required

The unique identifier of who last updated the user.

user_type'AGENT' | 'HUMAN' | 'MACHINE_CREDENTIAL' required

Specifies the type of the entity.

Example response

{
  "active": true,
  "client_identifier": "00000000-0000-0000-0000-000000000000",
  "email": "example@mail.com",
  "identifier": "00000000-0000-0000-0000-000000000000",
  "name": "John Doe",
  "user_type": "HUMAN"
}