Skip to main content
Connect Elisity to query device inventory, sites, and policy information from Serval workflows. Workflows can also manage device records in an Elisity custom connector when the API client has the corresponding write permissions.

​
Create an API client

  1. Sign in to Elisity Cloud Control Center as an administrator.
  2. Open Settings > Admin > User Management > API Clients.
  3. Create an API client for Serval. Choose a role with the permissions your workflows need, and set an appropriate access duration.
  4. Save the Client ID and Client Secret.
See Elisity’s API access guide for the API client setup process and its privilege reference for endpoint permissions. Device inventory, sites, and policy reads require their respective view privileges. Give the client write privileges only for workflows that need to change data.

​
Connect in Serval

  1. Open Integrations, find Elisity, and choose Connect.
  2. Enter your Cloud Control Center URL, such as https://your-tenant.idp01.elisity.io.
  3. Enter the Client ID and Client Secret, then connect.
The tenant hostname must end in .elisity.io. Enter only the tenant URL, without an API path, query, or port. Serval obtains access tokens using the API client’s credentials.

​
Use the connection

Use the Elisity connection in workflows to look up devices, inspect sites and policies, and call supported custom connector inventory endpoints. Connecting Elisity does not automatically import devices into Serval’s asset inventory.
Updating or deleting a custom connector device record can change its policy group membership and network access. Review the intended change before running a workflow that writes to Elisity.
Available APIs depend on your Elisity release and API client’s role. Your tenant publishes its full OpenAPI specification at /v3/api-docs, and its Help menu provides the interactive API documentation.

​
Troubleshooting

  • Authentication fails: Check the client ID, secret, API client expiration, and tenant URL. Update the Serval connection after rotating the secret.
  • An API returns 403: Check that the client’s role has the required endpoint privilege. A valid token does not grant every API permission.
  • Changing tenants: Re-enter the client secret when changing the tenant URL. Credentials are tied to the configured tenant.