Accessing the Hyland IdS Administration API - Accessing the Hyland IdS Administration API - You can access the Hyland IdS Administration API in Swagger. - Perceptive Content - OnBase - Other - Identity and Access Management Services - Other/Identity-and-Access-Management-Services/5.3/Identity-and-Access-Management-Services/Configuring-Providers-and-Clients-Using-the-IdS-Service-Account/Configuring-Swagger-Using-Environment-Variable/Accessing-the-Hyland-IdS-Administration-API - 5.3 - 5.3

Identity and Access Management Services
Platform
Other
Product
Identity and Access Management Services
Release
5.3
License
ft:lastPublication
2026-05-22T12:39:50.585000
ft:locale
en-US

You can access the Hyland IdS Administration API in Swagger.

You must have configured Swagger in the appsettings.json file of Hyland IdS. See Configuring Swagger Using Environment Variable for instructions.

To access the Hyland IdS Administration API:

  1. Navigate to the link [baseurl]/api-docs/index.html on a browser. For example, http://server/identityservice/api-docs/index.html, where http://server/identityservice is the [baseurl].
    The IdS Administration API page with the available API collection is displayed.
  2. Select Authorize.
    The Available authorizations dialog box is displayed.
    Available authorizations dialog box
  3. Enter the Client ID in the client_id field.
  4. Enter the Client Secret in the client_secret field.
  5. Select Authorize.
    You can now access and execute any API calls using the Swagger UI.