Postman Collections
Postman is a platform you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a public workspace for the Identity Security Cloud API collections. You can use this workspace to access all the ISC API collections and stay up to date.
Run in Postman
Each ISC API version is broken out into a separate collection within the workspace. The following table lists the available ISC API collections. To import a collection into your workspace, select the 'Run in Postman' button for your desired version. Doing so forks the collection into your workspace.
| API | Postman Collection |
|---|---|
| V3 API |  |
| Beta API | |
| NERM API | |
| SaaS Connectivity | |
You can also fork a collection by selecting the ellipses to the right of the collection and selecting 'Create a fork.'
When you fork the collection, when you check the 'Watch original collection' checkbox to get notifications when there are changes to the collection, you will be notified by email whenever a collection changes.
Update your collections
SailPoint is often making improvements to the ISC API collections. To keep your workspace in sync with updates to one of SailPoint's public collections, you can right click on the forked collection and select "pull changes". sometimes this process will fail because of the size of our collection and limitations of the Postman tool. In that case, in order to update, you will need to visit the sailpoint workspace and create a fork of the most recently published version or click the links above to fork the most recent version.
Configure your environment
The SailPoint workspace provides an environment, a set of variables you can use in your requests, that you can fork and pull changes from to stay up to date the same way you can with collections. To import the environment into your workspace, select 'Run in Postman'.
| Environment | |
|---|
To send API requests in Postman, you must authenticate to the APIs. To authenticate to the APIs, you must specify these variables in your Postman environment:
| Environment Variable | Required | Description |
|---|---|---|
| tenant | Yes | Your ISC tenant, typically your company's name |
| clientId | Yes | The client ID for the API client or personal access token |
| clientSecret | Yes | The client secret for the API client or personal access token |
| domain | No | This optional field is only necessary for those who have a domain in their API URL that isn't "identitynow". |
Don't specify your baseUrl in your environment variables. When you fork an API collection, the baseUrl is automatically set as https://{{tenant}}.api.{{domain}}.com. Setting your baseURl in your environment variables may interfere with this process.
Once you have configured your environment, you can start using Postman with all the endpoints provided in the collections.
Anything you want to change about the Postman collection? We love feedback! Discuss the Postman collection here.