Command User Object

The following object is the general Verkada Command User object.

activeBoolWhether the user is active in the system.
company_nameStringThe name of the company the user is part of.
departmentStringThe name of the department the user is part of.
department_idStringThe department ID of the department the user is in.
emailString(Unique)The email of the user.
employee_idStringThe user's employee ID, does not have to be unique.
employee_typeStringThe type of employee.
external_idString(Unique AND Required)A unique identifier managed externally provided by the consumer.
first_nameString(Required)The first name of the user.
last_nameString(Required)The last name of the user.
middle_nameStringThe middle name of the user.
phoneStringThe main phone number of a user, E.164 format preferred.
user_idString(Unique)The unique identifier of the user managed by Verkada.

Sample Command User

    "active": true,
    "company_name": "Verkada",
    "department": "IT",
    "department_id": "34211",
    "email": "[email protected]",
    "employee_id": "123456",
    "employee_type": "Full-Time",
    "external_id": "123456",
    "first_name": "John",
    "last_name": "Smith",
    "middle_name": "Jacob",
    "phone": "+16508675309",
    "user_id": "d835e077-efb1-4911-a484-d1bd4be1cdbe"