VEverkada
Users

Update User

Updates a user's metadata for an organization based on either provided user ID or an external ID set during creation.

put/core/v1/user

Request

  • Base URL
    https://api.verkada.com
  • URL
    https://api.verkada.com/core/v1/user
  • Auth
    • API key in header x-verkada-auth
    • or API key in header x-api-key

Query parameters

user_idstring

The unique identifier of the user managed by Verkada.

external_idstring

A unique identifier managed externally provided by the consumer.

Request body

company_namestring

The name of the company the user is part of.

departmentstring

The name of the department the user is part of.

department_idstring

The department ID of the department the user is in.

emailstring

The email of the user.

employee_idstring

The user's employee ID, does not have to be unique.

employee_titlestring

The title of employee.

employee_typestring

The type of employee.

external_idstring

A unique identifier managed externally provided by the consumer.

first_namestring

The first name of the user.

last_namestring

The last name of the user.

middle_namestring

The middle name of the user.

phonestring

The main phone number of a user, E.164 format preferred.

Response

OK

activeboolean

Whether the user is active in the system.

company_namestring

The name of the company the user is part of.

departmentstring

The name of the department the user is part of.

department_idstring

The department ID of the department the user is in.

emailstring

The email of the user.

employee_idstring

The user's employee ID, does not have to be unique.

employee_titlestring

The title of employee.

employee_typestring

The type of employee.

external_idstring

A unique identifier managed externally provided by the consumer.

first_namestring

The first name of the user.

last_namestring

The last name of the user.

middle_namestring

The middle name of the user.

phonestring

The main phone number of a user, E.164 format preferred.

user_idstring

The unique identifier of the user managed by Verkada.

Changes

No recorded changes to this operation across all 1 revision of this API.