Skip to main content

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 IdentityNow API collections. You can use this workspace to access all the IDN API collections and stay up to date.

Run in Postman

Each IDN API version is broken out into a separate collection within the workspace. The following table lists the available IDN 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.

APIPostman Collection
V3 APIRun in Postman
Beta APIRun in Postman
V2 APIRun in Postman
cc/private APIRun in Postman
SaaS ConnectivityRun in Postman

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, it is recommended that you check the 'Watch original collection' checkbox to get notifications when there are changes to the collection. You can then pull the changes to merge them and stay up to date.

Update your collections

SailPoint is often making improvements to the IDN API collections. To keep your workspace in sync with updates to one of SailPoint's public collections, select the ellipse to the right of the collection, and select 'Pull changes'.

If there are no changes, you're up to date. If there are changes, the screen lists the changes you're pulling. Select 'Pull changes' again to pull them in.

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 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 VariableRequiredDescription
tenantYesYour IDN tenant, typically your company's name
clientIdYesThe client ID for the API client or personal access token
clientSecretYesThe client secret for the API client or personal access token
domainNoThis optional field is only necessary for those who have a domain in their API URL that isn't "identitynow".
caution

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.

tip

Anything you want to change about the Postman collection? We love feedback! Discuss the Postman collection here.