How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I use the Postman collections that are provided for AM (All versions)?

Last updated Aug 18, 2021

The purpose of this article is to provide information on using the Postman collections that have been provided in the Knowledge Base. These Postman collections help you easily and repeatedly perform tasks in AM using the REST API.

3 readers recommend this article

Postman collections in the Knowledge Base

The following articles provide Postman collections to help you easily perform REST tasks:

You can download the collection from the relevant article and use it as described in this article.

Installing Postman

First you need to install Postman and then import the required collections.

  1. Install Postman.
  2. Select the Manage Environments option from the Settings cog (No environment drop-down in the top right-hand corner of Postman if you do not have any environments configured). You can then add one or more environments or import this example one to get you started: ForgeRockRecordingExampleEnv.postman_environment. You should avoid including specific environment properties to make it easier to switch between environments without modifying your request. If you have multiple AM environments, it is recommended that you create a Postman environment for each one. You can do this by importing the example environment multiple times and then adjusting the values needed. The following examples show four AM environments, where only the port number differs:
  1. Import a collection by clicking the Import button in the top-left hand corner of Postman. You should now have a new collection on the left-hand side of Postman, like this:

By importing a Postman collection and having the correct environment configured, you should be able to use the example requests immediately. If you want to modify any of the requests, it is recommended that you duplicate the request prior to making changes in order to keep these examples intact for future reference.

Using Postman collections

All Postman collections included in articles have a series of example requests that include details to get you started and can be modified as needed.

The first request is always to Authenticate. Before running the authenticate request, you should edit the Headers to provide your credentials, for example:

Some requests will require you to update other parts of the REST request such as the Body or a URL parameter. The article providing the Postman collection will indicate what you should update:

  • Body: If you need to update the Body, you should provide the same details you would provide in a curl --data option, for example:
  • URL parameter: If you need to update a URL parameter (for example, to provide a realm name or agent name), you will see a colon (:) in the URL. Click the Params button to show the available URL parameters and update as needed, for example:

See Also

Postman - Getting started with Collections

Postman - Setting up an environment with variables

Postman - Using environments to switch contexts

Related Training


Related Issue Tracker IDs


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.