About OpenPath
OpenPath, now part of Avigilon Alta, is a cloud-based access control platform that provides touchless entry, mobile credentials, and comprehensive facility management. Connecting OpenPath to Serval enables automated access management, user provisioning, and security workflows directly from your service desk.What the OpenPath integration enables
| Capability | Description |
|---|---|
| Access Management | Create, update, and manage users and their access credentials |
| User Provisioning | Streamline employee onboarding with automatic OpenPath account setup |
| Entry Management | Manage access points, doors, and entry permissions |
| Group Management | Organize users into groups for simplified access control |
Prerequisites
- Admin access to your OpenPath organization in the Control Portal
- Your OpenPath account email and password
- Your OpenPath Organization ID
Finding Your Organization ID
OpenPath requires an Organization ID to route API requests to the correct organization. You can find your Organization ID directly from the OpenPath Control Portal URL.1
Log in to OpenPath Control Portal
Navigate to control.openpath.com and log in with your admin credentials.
2
Find the Organization ID in the URL
Once logged in, look at the URL in your browser’s address bar. The Organization ID is the number that appears after The Organization ID is 302.
/o/ in the URL.For example, in the URL:3
Copy the Organization ID
Make note of this number—you’ll need it when configuring the Serval integration.
Serval Configuration
1
Navigate to the OpenPath integration
In Serval, go to Apps → Available → OpenPath → Connect
2
Enter your credentials
Fill in the following fields:
| Field | Description |
|---|---|
| Organization ID | Your OpenPath Organization ID (found in the portal URL) |
| Your OpenPath admin account email | |
| Password | Your OpenPath admin account password |
3
Save the integration
Click Save to complete the setup. Serval will validate your credentials and establish the connection.
How Authentication Works
The OpenPath integration uses username/password authentication to obtain JWT tokens for API access:- Login Request: When making API calls, Serval authenticates with your email and password
- JWT Token: OpenPath returns a JWT token that authorizes subsequent requests
- Organization Scoping: All API requests are scoped to your Organization ID (e.g.,
/orgs/302/users) - Automatic Handling: Token management is handled automatically by Serval
If your OpenPath account has Multi-Factor Authentication (MFA) enabled, you may need to use an app-specific password or contact OpenPath support for API access configuration.
Troubleshooting
Common Issues
“Authentication Failed” Error- Verify your email and password are correct
- Ensure the account has admin permissions in OpenPath
- If MFA is enabled, check if you need to configure app-specific credentials
- Double-check the Organization ID from your OpenPath portal URL
- Ensure the Organization ID is entered as a number without any extra characters
- Verify your account has access to the specified organization
- Confirm your OpenPath account has sufficient admin privileges
- Some API endpoints may require specific role permissions
- Contact your OpenPath administrator to verify account permissions
- OpenPath enforces API rate limits to ensure platform stability
- If you encounter this error, reduce the frequency of API calls
- Consider implementing request batching for bulk operations
API Reference
For complete API documentation, refer to the official Avigilon Alta API guides:Need help? Contact [email protected] for assistance with your OpenPath integration.