Verkada's Access Control API gives our customers the ability to have fine-grained control over all of their Access User's attributes. Here we list all the relevant objects necessary for that control.
Access Information Object
{
"user_id" : STR(UNIQUE),
"external_id" : STR(UNIQUE),
"start_date" : STR,
"end_date" : STR,
"ble_unlock" : BOOL,
"remote_unlock" : BOOL,
"entry_code" : STR(UNIQUE),
"access_groups" : LIST[Access Group Object],
"card" : LIST[Access Card Object],
"license_plates" : LIST[License Plate Object]
}
Access Card Object
{
"type" : STR,
"facility_code" : STR(Optional),
"card_id" : STR(UNIQUE),
"card_number_hex" : STR(OPTIONAL),
"card_number_base36" : STR(OPTIONAL),
"card_number" : STR(OPTIONAL),
"active" : BOOL
}
License Plate Object
{
"license_plate_number" : STR,
"name" : STR(OPTIONAL),
"active" : BOOL(OPTIONAL)
}
Access Group Metadata Object
{
"group_id" : STR(UNIQUE),
"name" : STR(UNIQUE)
}
Access Group Object
{
"group_id" : STR(UNIQUE),
"name" : STR(UNIQUE),
"access_members" : LIST[Access User ID Map Object],
"created_at" : STR
}
Access User ID Map Object
{
"user_id" : STR(UNIQUE),
"external_id" : STR(UNIQUE)
}