Configure Connection
Verkada guide
Prepare a Verkada API key, configure the organization connection in NIM, and validate user auditing and card creation.
Before you beginDirect link to Before you begin
Review the vendor's Verkada API Quick Start Guide. An Organization Admin must create the API key in Verkada Command.
NIM requires Tenant URL, API Key, and Organization ID.
Prepare API accessDirect link to Prepare API access
- In Verkada Command, open Organization Settings > Verkada API and select + New API Key.
- Name the key and configure its permission scope. Grant read access for user and access auditing, and read/write access for card creation.
- Set the expiration and generate the key. Copy it to secure storage; Command displays it only once.
- Record the organization ID and identify the API address for your region.
Use the API key in NIM's connection settings. The vendor distinguishes this key from the short-lived API token used for endpoint requests.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Verkada system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The Verkada API address for your region, using the format expected by the Connection screen. |
| API Key | The API key generated in Verkada Command. |
| Organization ID | The ID of the Verkada organization that NIM will access. |
Test access user retrievalDirect link to Test access user retrieval
-
Select Test Connection. NIM attempts to retrieve access users using:
GET /access/v1/access_users -
If the test fails, verify the Tenant URL, API Key, Organization ID, key expiration, permission scope, and network access.
-
Collect users, user details, groups, memberships, and cards needed for your process and validate the results in NIM.
-
Validate card creation with a test user and confirm the result in Verkada before enabling automation.
The connection test checks access user retrieval. Validate other collections and card creation separately. The connector's user and group data is read-only; user cards support reading and creation.