PingOne for Developers is intended to get you up and running quickly, taking you through the steps to create your first worker application and obtain an access token, which is needed to interact with PingOne APIs. In addition, this guide also provides topics to help you answer the “big picture” questions you might have about the PingOne platform.

PingOne API domains {#pingone-api-domains}

The PingOne API includes the following regional domains.

Note: This section discusses how PingOne API regional endpoints are entered in the domain name system (DNS). In DNS, and in our endpoints, the domain part of the uniform resource locator (URL) comprises three parts separated by periods, such as api.pingone.com: one of our service-specific subdomains, our PingOne domain name of pingone, and one of our top level domains. PingOne APIs use api, auth, orchestrate-api, and scim-api subdomains. The top level domain (TLD) represents a region and PingOne APIs use com, ca, eu, and asia.

We use Postman variables to manage this variety of domain parts in PingOne API endpoints. The later discussion is correct regarding the domain part that the variables evaluate to. However, to ease maintenance, the Postman environment template you get when you Download the PingOne Postman collections uses variables to isolate the TLD from the rest of the domain part and to isolate the domain part from the rest of the endpoint.

The environment template has a path variable for each subdomain: {{apiPath}}, {{authPath}}, {{orchestratePath}}, and {{scimPath}}. Each path variable uses another variable, {{tld}}, for the TLD, such as https://api.pingone.{{tld}}/v1 for {{apiPath}}. The tld variable is first in the environment template that you downloaded. To change your region, simply change the default com to your region’s TLD.

api.pingone.com, api.pingone.ca, api.pingone.eu, and api.pingone.asia

These are the primary domains for calling PingOne Management API resource server, with api.pingone.com used for environments in the North America region (excluding Canada), api.pingone.ca for environments in the Canada region, api.pingone.eu for environments in the European Union region, and api.pingone.asia for environments in the Asia-Pacific region.

The {{apiPath}} variable in the sample requests represents the regional domain for the PingOne server. This variable stands for https://api.pingone.com/v1 for environments in the North America region (excluding Canada), 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. Note that the trailing /v1 is required.

auth.pingone.com, auth.pingone.ca, auth.pingone.eu, and auth.pingone.asia

This is the authorization and authentication server domain called to request the access token required to authenticate PingOne API requests, with auth.pingone.com used for environments in the North America region (excluding Canada), auth.pingone.ca for the Canada region, auth.pingone.eu for the European Union region, and auth.pingone.asia for the Asia-Pacific region.

The {{authPath}} variable in the sample requests represents the regional domain for the PingOne authentication server. This variable stands for https://auth.pingone.com for the North America region (excluding Canada), 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. Note that nothing trails the domain in the {{authPath}} variable.

orchestrate-api.pingone.com, orchestrate-api.pingone.ca, orchestrate-api.pingone.eu, and orchestrate-api.pingone.asia

These are the primary domains for calling the PingOne DaVinci Management API resource server, with orchestrate-api.pingone.com used for environments in the North America region (excluding Canada), orchestrate-api.pingone.ca for environments in the Canada region, orchestrate-api.pingone.eu for environments in the European Union region, and orchestrate-api.pingone.asia for environments in the Asia-Pacific region.

The {{orchestratePath}} variable in the DaVinci requests documentation represents the regional domain for the PingOne server. This variable stands for https://orchestrate-api.pingone.com/v1for environments in the North America region (excluding Canada), https://orchestrate-api.pingone.eu/v1 for environments in the European Union region, https://orchestrate-api.pingone.ca/v1 for environments in the Canada region, and https://orchestrate-api.pingone.asia/v1 for environments in the Asia-Pacific region. Note that the trailing /v1 is required.

scim-api.pingone.com, scim-api.pingone.ca, scim-api.pingone.eu, and scim-api.pingone.asia

These are the primary domains for calling the PingOne System for Cross-domain Identity Management (SCIM) API resource server, with scim-api.pingone.com used for environments in the North America region (excluding Canada), scim-api.pingone.ca for environments in the Canada region, scim-api.pingone.eu for environments in the European Union region, and scim-api.pingone.asia for environments in the Asia-Pacific region.

The {{scimPath}} variable in the SCIM requests documentation represents the regional domain for the PingOne SCIM server. This variable stands for https://scim-api.pingone.com/v1 for environments in the North America region (excluding Canada), https://scim-api.pingone.eu/v1 for environments in the European Union region, https://scim-api.pingone.ca/v1 for environments in the Canada region, and https://scim-api.pingone.asia/v1 for environments in the Asia-Pacific region. Note that the trailing /v1 is required.

When copying a call from the request examples, such as a cURL example, the Postman variable ({{apiPath}}, {{authPath}}, {{orchestratePath}}, {{scimPath}}) cannot contain the “https://” prefix. The HTTP operation specified in the call (such as, POST) precludes this. Including “https://” will therefore generate an error.