AM 7.4.0

Online REST API reference

AM provides an online AM REST API reference that can be accessed through the AM admin UI. The API Explorer displays the REST API endpoints that allow client applications to access AM’s services.

The API Explorer is enabled by default. For security reasons, it is strongly recommended that you disable it in production environments.

To disable the API Explorer, go to Configure > Global Services > REST APIs, and select Disabled in the API Descriptors drop-down list.

The key features of the API Explorer are the following:

  • API versioning. The API Explorer displays the different API versions available depending on your deployment.

    API Explorer page, which is accessible from the AM admin UI
    Figure 1. API Explorer
  • Detailed information. The API Explorer provides an Expand Operations button for each available CRUDPAQ method. Expand Operations displays implementation notes, successful response class, headers, parameters, and response messages with examples. For example, you can populate the requestPayload field with an example value. If you select Model, you can view the schema for each parameter, as follows:

    The API Explorer page provides a Try It Out function that allows you to see the possible responses to an example request. The requestPayload field also provides a Model function to display the schema.
    Figure 2. API Explorer Request Payload
  • Try It Out. The API Explorer also provides a Try It Out feature that lets you send a sample request to the endpoint, and view the possible responses.

    The API Explorer page displays detailed information for each method.
    Figure 3. API Explorer Detailed Information

    Note the following when using the Try It Out feature:

    • The example payload values are auto-generated, and while they may be the correct data type, their value may not be correct for the API to function correctly. See the Model tab for a description of the required value, and replace the example values before sending the REST request to AM.

    • Endpoints in the API Explorer are hard-coded to point to the top-level realm. You must adjust either the domain, or the path in the request, to target a different realm.

      For more information, see Specify realms in REST API calls.

Access the API Explorer

  1. From the AM admin UI, you can access the API Explorer in one of two ways:

    Point your browser to the following URL:

    You can also click the help icon in the top-right corner, and click API Explorer.

    API Explorer page, which is accessible from the help icon on the AM admin UI
    Figure 4. API Explorer
Copyright © 2010-2024 ForgeRock, all rights reserved.