Sign in
User

Create a user

Create a new user in your organization.

post/user

Request body

emailstring required

The email of the user you want to create.

first_namestring required

The first name of the user you want to create.

last_namestring required

The last name of the user you want to create.

organization_idinteger required

The organization ID of the user you want to create.

avatarstring

The avatar of the user you want to create.

send_inviteboolean

Whether to send an invite email to the user.

Example request

{
  "email": "alex.doe@email.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "organization_id": 1234,
  "avatar": "https://my-avatar-url.com",
  "send_invite": true
}

Response

The operation was successful.

idinteger required

The ID of the user.

emailstring required

The email of the user.

first_namestring nullable required

The first name of the user.

last_namestring nullable required

The last name of the user.

organization_idinteger required

The organization ID of the user.

status'active' | 'inactive' | 'pending' | 'invited'

The status of the user.

avatarstring nullable

The avatar of the user.

type'person' | 'machine'

The type of the user.

provider'cognito' | 'saml' nullable

The authentication provider of the user.

nrnstring required

The NRN of the user.

send_inviteboolean

Whether to send an invite email to the user.

metadataobject

The metadata of the user.

Example response

{
  "id": 123456,
  "email": "alex.mgr@crypto-inc.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "organization_id": 1234,
  "status": "active",
  "avatar": "https://my-avatar-url.com",
  "type": "person",
  "provider": "cognito",
  "nrn": "organization=123",
  "send_invite": true,
  "metadata": {
    "key": "value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.