search
apis

Get Started With Postman

Take a test drive with our REST APIs. Use our Postman API Collection. With our collection, you can manage:

  • Apps
  • Users
  • Password Policies
  • Hosted Pages
  • Authentication

postman

Step 1: Get Postman

Step 2: Download our Collection

Step 3: Import Our APIs

3a. Start Postman.

3b. In the Postman app, select Import to open the following window:

alt text

3c. Select Choose Files and navigate to the directory where you cloned our Postman repository.

3d. Import the following files:

3e. After the import is complete, highlight our CIAM Express API collection.

3f. In the No Environment drop down text box, select the Express CIAM vars option.

alt text

Step 4: Customize the Environment

4a. Find your tenantName. It’s a part of your console URL. For example, if your admin console is at https://ui-mytenant.forgeblocks.com/signin, your tenantName is mytenant.

4b. Find the access token for your environment. Open the developer tools for your console, sign in, and find the GET session REST call. You’ll find the access token as an Authorization: Bearer {accessToken}:

alt text

4c. Include these items in your environment. In the Postman app, select the gear icon in the upper right corner, and select ForgeRock Environment Variables.

alt text

4d. Now you’re ready to use our Postman collection on your ForgeRock CIAM Express Environment!

Step 5: Try it out!

In this step, we’ll show you how to use our Postman collection to create a Native/SPA app.

5a. In your Postman client, navigate to Management APIs > Native/SPA Apps > Create a Native/SPA app.

5b. Select Send. In the output, you’ll see the details of your new Native/SPA app.

alt text

5c. You can confirm the result in the console. Once you’ve signed in, navigate to Applications, and you’ll see your new app in the list.