Our Use Cases documentation describes the workflows for common PingOne use cases, both for the platform and its services. Each use case is configured as a Postman collection, and includes a Run in Postman button, enabling you to load the use case collection in your Postman workspace.
To access the PingOne APIs, you’ll first need to create an application connection, and get the assigned access token. See Getting started in our Developer Guide for instructions.
Before you begin using the Postman collections linked to PingOne use cases, you must configure your Postman preferences to not follow redirects automatically. Several PingOne use cases, particularly those that involve an authorize request, an authentication flow, and a redirect back to the authorization server, will not execute the steps in the Postman collection as intended if Postman’s Automatically follow redirects setting is turned on.
To disable the Automatically follow redirects setting in Postman:
Open your Postman application, and under the Postman menu, click Preferences.
On the Settings screen, click the General tab, if it is not already open.
Under the Headers column, set the Automatically follow redirects setting to OFF.
For more information about Postman preferences, see Setting up Postman.
When you run use case collections that involve authentication flows, the PingOne API uses session token cookies to establish the user’s authentication session and maintain the session throughout the workflow. Postman functions as the calling client saves these cookies, allowing the flow to redirect back to the authorization server to get an access token.
Before you run any use cases, it is recommended that you remove all old session token cookies from Postman. To remove cookies:
Open the Step 1 request for the use case you want to run.
Click the Cookies link, which is directly under the Send button.
On the Manage Cookies screen, delete all session token cookies listed until you see the No Cookies available message.
For more information about Postman and cookie management, see Using cookies.
The PingOne use case collections include test scripts that write variables and their current values to your active Postman environment for the newly created PingOne resources. To save and use these resource IDs, you should specify a Postman environment and have the following Postman environment variables set before you begin:
The regional domain for the PingOne server. These IDs identify a specific configured application in PingOne. Options are: https://api.pingone.com/v1 for environments the North America region, https://api.pingone.ca/v1 for environments in the Canada region, https://api.pingone.eu/v1 for environments in the European Union region, and https://api.pingone.asia/v1 for environments in the Asia-Pacific region.
The domain for the PingOne authentication server. Options are: https://auth.pingone.com for the North America region, https://auth.pingone.ca for the Canada region, https://auth.pingone.eu for the European Union region, and https://auth.pingone.asia for the Asia-Pacific region.
The UUID of an environment resource. This ID identifies your current working domain within your organization.
A valid access token returned by the PingOne authorization server from the worker application in your current environment. For information about creating a worker application and getting an access token, see Getting started.
If you download and import any of the PingOne master postman collections into Postman (see Download the PingOne Postman collections), the collection import includes a PingOne Postman environment template automatically. You can use this Postman environment with the use case collections, or any Postman environment you have created previously that includes values for the variables listed above.
For more information about the PingOne Postman environment template, see Use the PingOne Postman environment template.