REST API Explorer
IDM includes an API Explorer, an implementation of the OpenAPI Initiative Specification, also known as Swagger.
To access the API Explorer, log in to the Admin UI, select the question mark in the upper right corner, and choose API Explorer from the drop-down menu.
If the API Explorer does not appear, you might need to enable it in your
resolver/boot.properties file by setting the
openidm.apidescriptor.enabled property to
The API Explorer covers most of the endpoints provided with a default IDM installation.
Each endpoint lists supported HTTP methods, such as POST and GET. When custom actions are available, the API Explorer lists them as HTTP Method
To see how this works, navigate to the
User endpoint, select List Operations, and choose the GET option associated with the
In this case, the defaults are set, and all you need to do is select the
Try it out! button. The output you see includes:
The REST call, in the form of the curl command.
The request URL, which specifies the endpoint and associated parameters.
The response body, which contains the data that you requested.
The HTTP response code; if everything works, this should be
If you see a
401 Access Denied code in the response body, your session may have timed out, and you'll have to log in to the Admin UI again.
For details on common ForgeRock REST parameters, see "About ForgeRock Common REST".
You'll see examples of REST calls throughout this documentation set. You can try these calls with the API Explorer.
You can also generate an OpenAPI-compliant descriptor of the REST API to provide API reference documentation specific to your deployment. The following command saves the API descriptor of the managed/user endpoint to a file named
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ --output "my-openidm-api.json" \ "http://localhost:8080/openidm/managed/user?_api"
For information about publishing reference documentation using the API descriptor, see "To Publish OpenAPI Documentation".