> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lumos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verkada

## After this article

You'll be able to connect Verkada to Lumos to ingest and sync users and groups. Verkada is a read-only integration today.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| - | - | - | - | - |
| Users | Account | Yes | No | User account records |
| Groups | Permission | Yes | No | Access Groups |

## Required plan and roles

* **Verkada role:** you must be an **Organization Admin** in Verkada Command to create the API key.
* **API access:** the API key needs Read-Write access to **Core Command**, the **Access API**, and **API Login** (API Login can be part of Core Command).

## Read-only access vs provisioning

**Is read-only possible?** Yes. Verkada is a read-only integration today. Lumos syncs users and access groups but doesn't create, update, or deprovision anything in Verkada.

**What read-only requires.** An API key created by an Organization Admin in Verkada Command (Settings > Verkada API), granted Read-Write access to Core Command, the Access API, and API Login, plus your Tenant Identifier and Region. Follow the steps below.

**Watch out for.** Even though Lumos only reads data today, Verkada requires the API key itself to carry Read-Write access. There is no narrower, read-only key type documented for these APIs, so you can't restrict the key further and expect the sync to keep working. Create the key with no expiration or the longest available range, since an expiring key breaks the connection and forces a reconnect with a fresh one.

## Instructions

**Phase 1: Gather your API key**

1. Log into Verkada Command as an Organization Admin.
2. Go to **Settings > Verkada API**.
3. Click **+ New API Key** to create a new key.
4. Grant Read-Write access to **Core Command**, the **Access API**, and **API Login**.
5. Select no expiration time, or the future-most time range available. Setting an expiration time will require reconnecting this integration later.
6. Copy the created API key so you can paste it into Lumos.

**Phase 2: Gather your tenant identifier and region**

1. Note your **Tenant Identifier**, the unique identifier for your Verkada account (your company name, for example).
2. Note your **Region**, the region of your Verkada instance. This defaults to US.

**Phase 3: Enter in Lumos and connect**

1. Find the Verkada card in your Lumos integrations (reconnect an existing card or add a new one).
2. Paste your API key, and enter your Tenant Identifier and Region.
3. Click **Connect**.

## API Endpoints Used

<Note>
  The API endpoints this integration uses are available to logged-in Lumos customers. [Log in](/login) to view them.
</Note>

## Troubleshooting

**Connection stops working after some time.** If the API key was created with an expiration time, it will expire and the integration will need to be reconnected with a fresh key. Create the key with no expiration or the future-most time range to avoid this.

**Authentication fails.** Confirm the key has Read-Write access to Core Command, the Access API, and API Login, and that it was created by an Organization Admin.