Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Users

This endpoint allows users to create a user in the account. The created user will be in pending state and a verification email will be sent to the user. Once approved, the newly created user will be in active state and will be able to be used.

post/users

Request body

firstNamestring required

First name of the user.

lastNamestring required

Last name of the user.

emailstring email required

This email is used for login.

rolesstring[]

List of role IDs assigned to the user. When a user is created, they can only have either roles or permissions assigned. Furthermore, the roles feature has to be enabled for the account.

grantAllLayoutsboolean

Indicates whether the newly created user will inherit access to all layouts from the user who created them.

grantAllCamerasboolean

Indicates whether the newly created user will inherit access to all cameras from the user who created them.

grantAllLocationsboolean

Indicates whether the newly created user will inherit access to all locations from the user who created them.

grantAllAccountsboolean

Indicates whether the newly created user will inherit access to all accounts from the user who created them. It should be used only from reseller context. In case of used from the sub-account context the flag will be ignored.

grantAllSpeakersboolean

Indicates whether the newly created user will inherit access to all speakers from the user who created them.

grantAllMultiCamerasboolean

Indicates whether the newly created user will inherit access to all multi cameras from the user who created them.

Response

User Created

idstring required
createTimestampstring date-time
firstNamestring required
lastNamestring required
emailstring email required

This email is used for login.

accountIdstring required
locationIdstring nullable

ID Of the location.

languagestring required
employeeIdstring nullable required

Custom text field

Example response

{
  "createTimestamp": "2023-04-04T09:38:37.372Z",
  "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2"
}