Create a user

Description: Create a new user. Only one user created per call.

SecuritybearerAuth
Request
Request Body schema:
allowVideoSearchDownload
boolean or null

The setting that allows users to download video files from the "saved videos" within video search.

Only applies to users with Video Reviewer and Video Reviewer Plus roles. All other user roles will return an error.

cellPhoneCountry
string or null

A user's cell phone country code (US/CA support only). Must be used with cellPhoneNumber.

cellPhoneNumber
string or null

A user's cell phone number. Must be used with cellPhoneCountry.

email
string or null

A user's email address.

employeeId
string or null

A user's employee id.

firstName
required
string

A user's first name.

required
Array of objects (GroupRole)

A list of user's group roles.

If maintaining or adding roles to a user, Group Roles must be provided.

If removing roles from a user, Group Roles must be removed.

lastName
required
string

A user's last name.

loginEnabled
boolean or null
Default: false

The setting that allows for login.

password
string or null

A user's password. Optional unless loginEnabled is true.

primaryGroupId
string or null <uuid>

A driver's home group for event follow driver.

If no group ID is provided, records are sorted by the highest group level the user belongs to. Competing group levels are tiebroken in alphabetical order.

*Only applicable for companies with event follow driver enabled.

username
string or null

A user's username. Username is unique across all Lytx accounts.

If no username is provided, then a username is automatically generated.

Usernames are generated in the following order:

  1. If employee ID exists, username generates as FirstnameLastnameEmployeeID.
  2. If no employee ID exists, username generates as FirstnameLastname.
  3. If a username already exists with FirstnameLastname, username generates as FirstNameLastName + 8digithash, depending on employeeID.
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/users
Request samples
{
  • "allowVideoSearchDownload": false,
  • "cellPhoneCountry": "US",
  • "cellPhoneNumber": "+1234567890",
  • "email": "email@email.com",
  • "employeeId": "j.smith",
  • "firstName": "John",
  • "groupRoles": [
    ],
  • "lastName": "Smith",
  • "loginEnabled": true,
  • "password": "123Abcd!",
  • "primaryGroupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
  • "username": "j.smith"
}
Response samples
application/json
{
  • "userId": "4af860ae-2e53-4d8b-a48e-606b862effed",
  • "allowSafetyEventDownload": false,
  • "allowVideoSearchDownload": false,
  • "cellPhoneCountry": "US",
  • "cellPhoneNumber": "+1234567890",
  • "createdDate": "2025-06-20T11:25:07.848413-07:00",
  • "email": "email@email.com",
  • "employeeId": "j.smith",
  • "firstName": "John",
  • "groupRoles": [
    ],
  • "lastLoginDate": "2025-06-24T11:25:07.848507-07:00",
  • "lastName": "Smith",
  • "loginEnabled": true,
  • "primaryGroupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
  • "status": "Active",
  • "updatedDate": "2025-06-27T11:25:07.848603-07:00",
  • "username": "j.smith"
}
© 2023 Lytx, Inc. All rights reserved