RapidIdentity Product Guide: New UI

Swagger API Documentation

For anyone with the API Developer Role, the Swagger-defined APIs can be accessed by following these three steps.

  1. Open a browser tab and type this address: https://<hostname or IP address>/api.

  2. Click the Swagger link, which will be in this format: https://<hostname or IP address>/api/rest/api-docs?url=/api/rest/swagger.json.

    Note

    This URL can be bookmarked for convenience.

  3. The Swagger-defined APIs may take a moment to load. This behavior is normal and expected. Once loaded, the APIs appear as shown. 

    Appliance_Capabilities_3.png