Create an entity user

Create a new entity user from the specified values.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
first_namestringRequired<=255 characters
The user's first name.
loginstringRequired<=255 characters

The username assigned to this user. Usernames must be unique within the entity.

The login value is not used by Monite but may be used by partner applications, for example, to map the users between the partner’s platform and Monite.

emailstringOptionalformat: "email"
The user's business email address.
last_namestringOptional<=255 characters
The user's last name.
phonestringOptional
The user's phone number.
role_idstringOptionalformat: "uuid"

ID of the role to assign to this user. The role defines the user’s access permissions within the entity. Each user has just one role.

titlestringOptional<=255 characters
The user's job title.

Response

Successful Response
idstringformat: "uuid"

A unique Monite-assigned ID of this entity user. Can be used with POST /auth/token to generate an API access token for this user.

created_atdatetime
UTC date and time when this user was created in Monite.
updated_atdatetime
UTC date and time when this user was last updated.
loginstring

The username assigned to this user. Usernames must be unique within the entity.

The login value is not used by Monite but may be used by partner applications, for example, to map the users between the partner’s platform and Monite.

role_idstringformat: "uuid"

ID of the role assigned to this user. The role defines the user’s access permissions within the entity. Each user has just one role.

statusenum

The user’s status. Always active.

Allowed values:
emailstring or nullformat: "email"
The user's business email address.
first_namestring or null
The user's first name.
last_namestring or null
The user's last name.
phonestring or null
The user's phone number.
userpic_file_idstring or nullformat: "uuid"

Unused. Reserved for future use. Currently always returns null.

Errors