The following object is the general Verkada Command User object.
Attribute | Type | Description |
---|---|---|
active | Bool | Whether the user is active in the system. |
company_name | String | The name of the company the user is part of. |
department | String | The name of the department the user is part of. |
department_id | String | The department ID of the department the user is in. |
String(Unique) | The email of the user. | |
employee_id | String | The user's employee ID, does not have to be unique. |
employee_type | String | The type of employee. |
external_id | String(Unique AND Required) | A unique identifier managed externally provided by the consumer. |
first_name | String(Required) | The first name of the user. |
last_name | String(Required) | The last name of the user. |
middle_name | String | The middle name of the user. |
phone | String | The main phone number of a user, E.164 format preferred. |
user_id | String(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"
}