Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Access User Information

Get Access Information Object

Given the Verkada created User Id, user defined External Id, email address, or employee ID, retrieve the Access Object Information for the specified user.

get/access/v1/access_users/user

Query parameters

user_idstring uuid

The unique identifier of the user managed by Verkada.

external_idstring

A unique identifier managed externally provided by the customer.

emailstring

The email address of the user.

employee_idstring

The organization-defined employee ID of the user.

Response

OK

ble_unlockboolean

The permission state of a user's ability to perform a Bluetooth Unlock. Format is a boolean True or False. Default is False.

end_datestring

The end time value of the time range controlling when a users credentials are active. Formatted as a Unix timestamp in seconds. Default is Null.

entry_codestring

The access pin code used for keypad readers alone or in 2FA mode. Formatted as a string of digits between 4 and 16 in length. Must be unique within the organization.

external_idstring

A unique identifier managed externally provided by the customer.

has_profile_photoboolean

A flag that states whether or not the user has a profile photo.

profile_photo_last_updatedstring date-time

The timestamp when the user's profile photo was last updated.

remote_unlockboolean

The permission state of a user's ability to perform a Remote Unlock. Format is a boolean True or False. Default is False.

start_datestring

The start time value of the time range controlling when a users credentials are active. Formatted as a Unix timestamp in seconds. Default is Null.

user_idstring uuid

The unique identifier of the user managed by Verkada.