Create a user

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.

cellPhoneCountry
string or null

A user's cell phone country code (US/CA support only).

cellPhoneNumber
string or null

A user's cell phone number.

email
string or null

A user’s email address.

employeeId
required
string

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.

lastName
required
string

A user’s last name.

loginEnabled
boolean or null

The setting that allows for login.

password
string or null

A user's password.

primaryGroupId
string or null <uuid>

A driver’s home group for event follow driver.

username
string or null

A user’s unique username.

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\":\"\\u002B1234567890\",\"email\":\"email@email.com\",\"employeeId\":\"j.smith\",\"firstName\":\"John\",\"groupRoles\":[{\"groupId\":\"90e49ea8-745c-40be-995b-808a754c3ad7\",\"roleId\":4}],\"lastName\":\"Smith\",\"loginEnabled\":true,\"password\":\"123Abcd!\",\"primaryGroupId\":\"90e49ea8-745c-40be-995b-808a754c3ad7\",\"username\":\"j.smith\"}"
Response samples
application/json
"{\"userId\":\"8c6bf473-5b8c-4087-998e-69328fc698bc\",\"allowSafetyEventDownload\":false,\"allowVideoSearchDownload\":false,\"cellPhoneCountry\":\"US\",\"cellPhoneNumber\":\"\\u002B1234567890\",\"createdDate\":\"2025-03-10T18:21:00.8996675+00:00\",\"email\":\"email@email.com\",\"employeeId\":\"j.smith\",\"firstName\":\"John\",\"groupRoles\":[{\"groupId\":\"90e49ea8-745c-40be-995b-808a754c3ad7\",\"roleId\":4}],\"lastLoginDate\":\"2025-03-14T18:21:00.8996686+00:00\",\"lastName\":\"Smith\",\"loginEnabled\":true,\"primaryGroupId\":\"90e49ea8-745c-40be-995b-808a754c3ad7\",\"status\":\"Active\",\"updatedDate\":\"2025-03-17T18:21:00.8996686+00:00\",\"username\":\"j.smith\"}"
© 2023 Lytx, Inc. All rights reserved