Configure Connection
Avigilon Openpath guide
Configure organization access in NIM, test site retrieval, and validate user and access management.
Before you beginDirect link to Before you begin
Refer to the vendor's Using the API documentation for API access configuration.
NIM requires Tenant URL, Org ID, Username, and Password.
Prepare organization accessDirect link to Prepare organization access
- Identify the tenant address and organization ID for your Openpath environment.
- Follow the vendor documentation to configure API access.
- Obtain an account with access to the organization and the data and operations required by your process.
- Ensure the NIM server can reach the tenant over HTTPS.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add an Avigilon Openpath system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The Openpath tenant address, using the format expected by the Connection screen. |
| Org ID | The organization ID used for API requests. |
| Username | The account used by NIM to access Openpath. |
| Password | The password for that account. |
Test site retrievalDirect link to Test site retrieval
-
Select Test Connection. NIM attempts to retrieve a single site using:
GET /orgs/{org_id}/sites?limit=1 -
If the test fails, verify the Tenant URL, Org ID, Username, Password, organization permissions, and network access.
-
Collect the data needed for your process and validate user, membership, and credential mappings in NIM.
-
Validate intended user lifecycle, membership, and credential changes with test records before enabling automation.
The connection test checks site retrieval. Validate other collections and each intended write operation separately. Sites, groups, namespaces, and credential types are read-only; memberships and credentials support creation and deletion, while users support creation, updates, and deletion.