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.

In the PingOne Postman download collections, for POST requests that create a resource and return a resource ID, these requests include a script that automatically adds a resource variable to your active Postman environment template and uses the newly created ID as the value.

For example, the following request from the PingOne Postman collection creates a new user. This request URL contains variables for the API path and environment ID:

POST {{apiPath}}/environments/{{envID}}/users

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 in 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.

Almost every request in PingOne requires an environment ID. If you are working primarily in one environment for testing purposes, you should add your environment’s UUID to the active Postman template as the value for the {{envID}} variable. In addition, requests to PingOne Management API endpoints require a valid access token to authenticate the request. In the PingOne download collections, the token value is represented in the Postman environment template as the variable {{accessToken}}. For more informaiton about getting a token, see Getting Started with the PingOne APIs.

With the {{apiPath}} and {{envID}} variables defined in your Postman template, and with a valid token value defined in the {{accessToken}} variable, you can run the request. If the request is successful, Postman adds a {{userID}} variable to the Postman template automatically, and it associates the new user’s id property value (the UUID of the new user) with this variable.

Common variable names

Here are some common variables used in the PingOne API Postman collections. These variables (and the new resource’s UUID as the value) are added automatically when you run a POST request successfully:

Postman variable PingOne resource
accessToken A valid access token returned by the POST /{{envID}}/as/token request.
actionID The UUID of a sign-on flow action resource. Action IDs are associated with the /environments/{{envID}}/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/{{envID}}/activities/{{activityID}} endpoint, and they identify specific audit event actions, such as APPLICATION.DELETED.
agreementID The UUID of an alert channel resource. Alert channel IDs are associated with the /environments/{{envID}}/agreement/{{agreementID}} endpoint.
alertChannelID The UUID of a terms of service agreement resource. Agreement IDs are associated with the /environments/{{envID}}/alertChannels/{{alertChannelID}} endpoint.
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.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.
apiServerID The UUID for an API server resource. API server resource IDs are used with the /environments/{{envID}}/apiServers/{{apiServerID}} endpoint.
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/{{envID}}/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.ca for the Canada 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/{{envID}}/certificates/{{certID}} endpoint to identify uploaded customer-provided certificates.
contentID The UUID of a content resource. Content IDs are associated with the /environments/{{envID}}/templates/{{templateName}}/contents/{{contentID}} endpoint to identify specific email, SMS or voice notifications content.
credentialID The UUID for an issued credential resource. Issued credential endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/users/{{userID}}/issuances/{{issuanceID}} endpoint.
credentialTypeID The UUID for an issued credential type resource. Issued credential type endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}} endpoint.
decisionEndpointID The UUID for a policy decision endpoint resource. Policy decision endpoint resource IDs are used with the /environments/{{envID}}/decisionEndpoints/{{decisionEndpointID}} endpoint.
deviceID The UUID of a device resource. Device IDs are associated with the /environments/{{envID}}/users/{{userID}}/devices/{{deviceID}} endpoint to associate devices with users for use in multi-factor sign-on actions.
domID The UUID of a custom domain resource. Custom domain IDs are associated with the /environments/{{envID}}/customDomains/{{domID}} endpoint.
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.
evaluationsID The UUID for a fraud evaluations resource. Fraud evaluations endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/fraudEvaluations/{{fraudEvaluationID}} endpoint.
feedbacksID The UUID for a fraud feedback resource. Fraud feedback endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/fraudFeedbacks/{{fraudFeedbackID}} endpoint.
flowID The UUID of an authentication flow resource. This ID is associated with the /{{envID}}/flows/{{flowID}} endpoint to identify the current authentication flow.
grantID The UUID of authorization grant resource. Grant IDs are associated with the /environments/{{envID}}/resources/{{resourceID}}/grants/{{grantID}} endpoint to identify authorization grant types. Grant IDs are also used with the /environments/{{envID}}/applications/{{appID}}/grants/{{grantID}} endpoint to associate resource grants with applications.
groupID The UUID of one specified group resource. Group IDs are used with the /environments/{{envID}}/groups/{{groupID}} endpoint.
idpAttrID The UUID of an identity provider attribute resource. Identity provider IDs are used with the /environments/{{envID}}/identityProviders/{{providerID}}/attributes/{{idpAttrID}} endpoint.
idpID The UUID of an identity provider resource. Identity provider IDs are used with the /environments/{{envID}}/identityProviders/{{providerID}} endpoint.
imgID The UUID of an image resource. Image IDs are associated with the /environments/{{envID}}/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/{{envID}}/keys/{{keyID}} endpoint to identify uploaded customer-provided signing/encryption keys.
languageID The UUID of a language resource. Language IDs are associated with the /environments/{{envID}}/languages/{{languageID}} endpoint to identify language resources.
licenseID The UUID of a license resource. License IDs are associated with the /environments/{{envID}}/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/{{envID}}/passwordPolicies/{{passwordPolicyID}} endpoint to associate password policies with the specified environment.
phoneDeliverySettingsID The UUID for a phone delivery settings resource. Phone delivery settings resource IDs are used with the /environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}} endpoint.
planID The UUID for a single propagation plan resource. Identity propagation plan resource IDs are used with the /environments/{{envID}}/propagation/plans/{{planID}} endpoint.
policyID The UUID of a sign-on policy resource. Sign-on policy IDs are used with the /environments/{{envID}}/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/{{envID}}/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/{{envID}}/applications/{{appID}}/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/{{envID}}/resources/{{resourceID}} endpoint.
resourceAttrID The UUID of a resource attribute resource. Resource attribute IDs are associated with the /environments/{{envID}}/resources/{{resourceID}}/attributes/{{resourceAttrID}} endpoint.
revisionID The UUID of a terms of service agreement revision resource. Revision IDs are associated with the /environments/{{envID}}/agreement/{{agreementID}}/languages/{{languageID}}/revisions/{{revisionID}} endpoint.
riskID The UUID for a risk evaluation resource. Risk evaluation endpoint resource IDs are used with the /environments/{{envID}}/riskEvaluations/{{riskID}} endpoint.
riskPolicySetID The UUID for a risk policy set resource. Risk policy set endpoint resource IDs are used with the /environments/{{envID}}/riskPolicySets/{{riskPolicySetID}} endpoint.
roleAssignmentID The UUID of a role assignment resource. These IDs are used with the environments/{{envID}}/{{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.
ruleID The UUID for a single propagation rule resource. Identity propagation rule resource IDs are used with the /environments/{{envID}}/propagation/rules/{{ruleID}} endpoint.
samlAttrID The UUID of an application attribute. Application attribute IDs (SAML or OIDC) are associated with the /environments/{{envID}}/applications/{{appID}}/attributes/{{resourceAttrID}} endpoint to identify application attribute mapping resources.
schemaID The UUID of a schema resource. Schema IDs are associated with the /environments/{{envID}}/schemas/{{schemaID}} endpoint to identify custom user schema resources.
scopeID The UUID of a scope resource. Scope IDs are used with the /environments/{{envID}}/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/{{envID}}/applications/{{appID}}/signOnPolicyAssignments/{{SOPAssignmentID}} endpoint to assign sign-on policies to the specified application.
storeID The UUID for a single propagation store resource. Identity propagation store resource IDs are used with the /environments/{{envID}}/propagation/stores/{{storeID}} endpoint.
subscriptionID The UUID for a subscription (webhooks) resource. Subscription resource IDs are used with the /environments/{{envID}}/subscriptions/{{subscriptionID}} endpoint.
templateName The name of a notifications template task resource. These names are used with the /environments/{{envID}}/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.
themeID The UUID of a branding theme resource. Branding theme IDs are used with the /environments/{{envID}}/users/{{userID}} endpoint to identify specific branding resources.
transactionID The UUID for a verification transaction record resource. Verification transaction record endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}} endpoint.
userID The UUID of a user resource. User IDs are used with the /environments/{{envID}}/themes/{{themeID}} endpoint to identify specific user resources and manage user attributes.
verifiedDataID The UUID for a verified data resource. Verified data endpoint resource IDs are used with the {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/verifiedData/{{verifiedDataID}} endpoint.