The Postman collection uses variables in the request URLs to specify UUIDs for PingOne resources within your organization. When you click the Run in Postman button here, this template downloads and installs automatically. With this environment template, you can associate your PingOne resource UUIDs with the common variables used in many of the requests.

For more information about using Postman environments, see the following topic in the Postman documentation: Environments in Postman.

For example, the following request from the PingOne Postman collection returns data about a specific user. This request contains variables for the api path, environment ID, and the user ID:

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}

To run this request, you must define a value for the {{apiPath}} with the regional domain associated with your organization. Options are: https://api.pingone.com/v1 for environments the North America 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.

In addition, you must define values for the {{envID}} and {{userID}} variables with the UUIDs for your environment and the specific user resource whose data you want to return. Almost every request in PingOne requires an environment ID, and if you are working primarily in one environment and with one user for testing purposes, then setting values for these variables in the Postman environment template will save time.

In addition, every request to PingOne Management API endpoints requires an access token to authenticate the request. The Authorization type for the endpoints in the Postman collections is configured to Bearer Token and the value of the token is set as the variable {{accessToken}}. You can create an access token variable in the Postman environment and set its value to your current valid token.

For authorization requests, you must define a value for the {{authPath}} variable, which specifies the domain associated with the authorization server. If you are not using a custom domain name, the value should be set to https://auth.pingone.com (initial value in the template), https://auth.pingone.eu, and https://auth.pingone.asia, depending on your region.

Common variable names

Here are some common variables used in the PingOne API Postman collections:

Postman variable PingOne resource
accessToken A valid access token returned by the PingOne authorization server.
actionID The UUID of a sign-on flow action resource. Action IDs are associated with the /environments/{environmentId}/signOnPolicies/{policyId}/actions/{actionID} endpoint to identify specific sign-on policy actions such as Single_Factor or Multi_Factor.
activityID The UUID of an audit activity resource. Activity IDs are associated with the /environments/{environmentId}/activities/{activityId} endpoint, and they identify specific audit event actions, such as APPLICATION.DELETED.
apiPath 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.eu/v1 for environments in the European Union region, and https://api.pingone.asia/v1 for environments in the Asia-Pacific region.
appID The UUID of an application resource. These IDs identify a specific configured application in PingOne. The appID is used to associate OIDC or SAML connection settings with the application specified by its UUID.
appSecret The value of the application secret. This ID has a minimum length of 64 characters per SHA-512 requirements when using the HS512 algorithm to sign ID tokens using the secret as the key.
attributeID The UUID of a custom attribute resource. Attribute IDs are associated with the /environments/{environmentId}/schemas/{schemaId}/attributes/{attributeID} endpoint to identify custom schema attributes.
authPath The domain for the PingOne authentication server. Options are: https://auth.pingone.com for the North America region, https://auth.pingone.eu for the European Union region, and https://auth.pingone.asia for the Asia-Pacific region.
certID The UUID of a certificate resource. Certificate IDs are associated with the /environments/{environmentId}/certificates/{certID} endpoint to identify uploaded customer-provided certificates.
contentID The UUID of a content resource. Content IDs are associated with the /environments/{environmentId}/templates/{templateName}/contents/{contentID} endpoint to identify specific email or SMS notifications content.
domID The UUID of a custom domain resource. Custom domain IDs are associated with the /environments/{{envID}}/customDomains/{domID} endpoint.
deviceID The UUID of a device resource. Device IDs are associated with the /environments/{environmentId}/users/{userId}/devices/{deviceID} endpoint to associate devices with users for use in multi-factor sign-on actions.
envID The UUID of an environment resource. This ID identifies your current working domain within your organization. Nearly all Management and Authentication API endpoints require an environment ID.
flowID The UUID of an authentication flow resource. This ID is associated with the /{environmentId}/flows/{flowId} endpoint to identify the current authentication flow.
grantID The UUID of authorization grant resource. Grant IDs are associated with the /environments/{environmentId}/resources/{resourceId}/grants/{grantID} endpoint to identify authorization grant types. Grant IDs are also used with the /environments/{environmentId}/applications/{appId}/grants/{grantID} endpoint to associate resource grants with applications.
idpAttrID The UUID of an identity provider attribute resource. Identity provider IDs are used with the /environments/{environmentId}/identityProviders/{providerId}/attributes/{idpAttrId} endpoint.
idpID The UUID of an identity provider resource. Identity provider IDs are used with the /environments/{environmentId}/identityProviders/{providerId} endpoint.
imgID The UUID of an image resource. Image IDs are associated with the /environments/{environmentId}/images{imgID} endpoint to associated custom image files with the specified environment resource, which can be used for custom branding of the PingOne admin UI.
keyID The UUID of an encryption key resource. Key IDs are associated with the /environments/{environmentId}/keys/{keyID} endpoint to identify uploaded customer-provided signing/encryption keys.
licenseID The UUID of license resource. License IDs are associated with the /environments/{environmentId}/licenses/licenseID} endpoint to identify PingOne licenses.
pairingKeyID The UUID of a pairing key resource. Pairing key IDs are used with the /environments/{envId}/users/{userId}/pairingKeys endpoint to associate device pairing keys with users.
passwordPolicyID The UUID of a password policy resource. Password policy IDs are used with the /environments/{environmentId}/passwordPolicies/{passwordPolicyID} endpoint to associate password policies with the specified environment.
policyID The UUID of a sign-on policy resource. Sign-on policy IDs are used with the /environments/{environmentId}/signOnPolicies/{policyID} endpoint to associate sign-on policies with the specified environment.
popID The UUID of a population resource. Population IDs are used with the /environments/{environmentId}/populations/{popID} endpoint to manage the populations to which users can be assigned.
pushCredID The UUID of a push credential resource. Push credentials IDs are used with the /environments/{environmentId}/applications/{applicationId}/pushCredentials/{pushCredID} endpoint to send push notifications to a native application.
resourceID The UUID of a protected endpoint resource. Resource IDs identify the protected endpoints that applications request access to using OAuth 2 or SAML authorization protocols. These IDs are associated with the /environments/{environmentId}/resources/{resourceID} endpoint.
resourceAttrID The UUID of a resource attribute resource. Resource attribute IDs are associated with the /environments/{environmentId}/resources/{resourceId}/attributes/{resourceAttrID} endpoint.
roleAssignmentID The UUID of a role assignment resource. These IDs are used with the environments/{environmentId}/{actorType}/{actorId}/roleAssignments/{roleAssignmentID} endpoint to identify the roles assigned to a specified actor.
roleID The UUID of a role resource. Role IDs are used with the /roles/{roleID} endpoint to identify platform roles defined in PingOne. Note that roles and role IDs are not associated with a specific environment.
samlAttrID The UUID of an application attribute. Application attribute IDs (SAML or OIDC) are associated with the /environments/{environmentId}/applications/{applicationId}/attributes/{samlAttrID} endpoint to identify application attribute mapping resources.
schemaID The UUID of a schema resource. Schema IDs are associated with the /environments/{environmentId}/schemas/{schemaID} endpoint to identify custom user schema resources.
scopeID The UUID of a scope resource. Scope IDs are used with the /environments/{environmentId}/resources/{resourceId}/scopes/{scopeID} endpoint to define the scopes associated with a resource access grant.
SOPAssignmentID The UUID of a sign-on policy assignment resource. These IDs are used with the /environments/{environmentId}/applications/{applicationId}/signOnPolicyAssignments/{SOPAssignmentID} endpoint to assign sign-on policies to the specified application.
templateName The name of a notifications template task resource. These names are used with the /environments/{environmentId}/templates endpoint to identify a specific notifications template, which is used as the container for delivering notifications content to users. Options are: offline_pairing, verification_code_template, recovery_code_template, and offline_authentication.
userID The UUID of a user resource. User IDs are used with the /environments/{environmentId}/users/{userID} endpoint to identify specific user resources and manage user attributes.