{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e05e8190-fbca-4b20-a921-12c489b39bfc","name":"PingOne Platform API with Documentation","description":"The documentation embedded in this collection is provided for your convenience. For the official Platform SSO APIs documentation, see [developer.pingidentity.com](https://developer.pingidentity.com/pingone-api/platform/introduction.html).\n\nPlatform SSO APIs collections use [Postman Collection-Level Authorization](https://developer.pingidentity.com/pingone-api/foundations/authentication-concepts/postman-collection-level-authorization.html) of type `bearer`. All requests that use bearer token authorization are set to `Inherit authorization from parent`.\n(2026-04-20 14:39)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"1848580","collectionId":"e05e8190-fbca-4b20-a921-12c489b39bfc","publishedId":"T17Q6jdj","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1848580/T17Q6jdj","privateUrl":"https://go.postman.co/documentation/1848580-e05e8190-fbca-4b20-a921-12c489b39bfc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"B3282D"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-01-25T15:04:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"PingOne Postman Environment Template (release: 2026-04-15)","id":"ae3973c1-110a-4773-90a0-078b32067c60","owner":"3468883","values":[{"key":"tld","value":"com","enabled":true,"type":"default"},{"key":"accessToken","value":"","enabled":true,"type":"default"},{"key":"accessTokenForEmailProvider","value":"","enabled":true,"type":"default"},{"key":"actionID","value":"","enabled":true,"type":"default"},{"key":"activityID","value":"","enabled":true,"type":"default"},{"key":"actToken","value":"","enabled":true,"type":"default"},{"key":"adminAppID","value":"","enabled":true,"type":"default"},{"key":"adminAppSecret","value":"","enabled":true,"type":"default"},{"key":"adminPassword","value":"","enabled":true,"type":"default"},{"key":"adminUsername","value":"","enabled":true,"type":"default"},{"key":"agreementID","value":"","enabled":true,"type":"default"},{"key":"alertChannelID","value":"","enabled":true,"type":"default"},{"key":"apiPath","value":"https://api.pingone.{{tld}}/v1","enabled":true,"type":"default"},{"key":"appID","value":"","enabled":true,"type":"default"},{"key":"appIdentifier","value":"","enabled":true,"type":"default"},{"key":"appResourceID","value":"","enabled":true,"type":"default"},{"key":"appRoleID","value":"","enabled":true,"type":"default"},{"key":"appSecret","value":"","enabled":true,"type":"default"},{"key":"appUrl","value":"","enabled":true,"type":"default"},{"key":"assertionFromBrowser","value":"","enabled":true,"type":"default"},{"key":"attributeID","value":"","enabled":true,"type":"default"},{"key":"authCode","value":"","enabled":true,"type":"default"},{"key":"authorizationVersionId","value":"","enabled":true,"type":"default"},{"key":"authorizeGatewayID","value":"","enabled":true,"type":"default"},{"key":"authPath","value":"https://auth.pingone.{{tld}}","enabled":true,"type":"default"},{"key":"base64encodedCredentials","value":"","enabled":true,"type":"default"},{"key":"basicAuthPassword","value":"","enabled":true,"type":"default"},{"key":"basicAuthUsername","value":"","enabled":true,"type":"default"},{"key":"bindPassword","value":"","enabled":true,"type":"default"},{"key":"capabilityName","value":"","enabled":true,"type":"default"},{"key":"certID","value":"","enabled":true,"type":"default"},{"key":"certificate","value":"","enabled":true,"type":"default"},{"key":"cibaAuthID","value":"","enabled":true,"type":"default"},{"key":"cibaHint","value":"","enabled":true,"type":"default"},{"key":"client_id","value":"","enabled":true,"type":"default"},{"key":"clientID","value":"","enabled":true,"type":"default"},{"key":"clientSecretJWT","value":"","enabled":true,"type":"default"},{"key":"code","value":"","enabled":true,"type":"default"},{"key":"companyID","value":"","enabled":true,"type":"default"},{"key":"configurationID","value":"","enabled":true,"type":"default"},{"key":"connectionID","value":"","enabled":true,"type":"default"},{"key":"contentID","value":"","enabled":true,"type":"default"},{"key":"credentialID","value":"","enabled":true,"type":"default"},{"key":"currency","value":"","enabled":true,"type":"default"},{"key":"currentPassword","value":"","enabled":true,"type":"default"},{"key":"customDomainID","value":"","enabled":true,"type":"default"},{"key":"customProviderClientSecret","value":"","enabled":true,"type":"default"},{"key":"customRoleID","value":"","enabled":true,"type":"default"},{"key":"date","value":"","enabled":true,"type":"default"},{"key":"davinciApiKey","value":"","enabled":true,"type":"default"},{"key":"davinciAppClientSecret","value":"","enabled":true,"type":"default"},{"key":"davinciAppID","value":"","enabled":true,"type":"default"},{"key":"davinciFlowPolicyID","value":"","enabled":true,"type":"default"},{"key":"deviceAppID","value":"","enabled":true,"type":"default"},{"key":"deviceCode","value":"","enabled":true,"type":"default"},{"key":"deviceID","value":"","enabled":true,"type":"default"},{"key":"dvResponse","value":"","enabled":true,"type":"default"},{"key":"email","value":"","enabled":true,"type":"default"},{"key":"emailDomainID","value":"","enabled":true,"type":"default"},{"key":"envAdmRole","value":"","enabled":true,"type":"default"},{"key":"envID","value":"","enabled":true,"type":"default"},{"key":"EnvIDConverged","value":"","enabled":true,"type":"default"},{"key":"externalAuthCode","value":"","enabled":true,"type":"default"},{"key":"externalProviderState","value":"","enabled":true,"type":"default"},{"key":"extIdpID","value":"","enabled":true,"type":"default"},{"key":"fallbackChainID","value":"","enabled":true,"type":"default"},{"key":"fallbackChainID-2","value":"","enabled":true,"type":"default"},{"key":"fallbackChainID-3","value":"","enabled":true,"type":"default"},{"key":"flowChallengeID","value":"","enabled":true,"type":"default"},{"key":"flowID","value":"","enabled":true,"type":"default"},{"key":"flowPolicyAssignmentID","value":"","enabled":true,"type":"default"},{"key":"flowPolicyId","value":"","enabled":true,"type":"default"},{"key":"flowPolicyID","value":"","enabled":true,"type":"default"},{"key":"formID","value":"","enabled":true,"type":"default"},{"key":"from","value":"","enabled":true,"type":"default"},{"key":"gatewayCredential","value":"","enabled":true,"type":"default"},{"key":"gatewayCredID","value":"","enabled":true,"type":"default"},{"key":"gatewayID","value":"","enabled":true,"type":"default"},{"key":"gatewayRoleAssignmentsID","value":"","enabled":true,"type":"default"},{"key":"googleCredentialsJsonContent","value":"","enabled":true,"type":"default"},{"key":"grantID","value":"","enabled":true,"type":"default"},{"key":"groupID","value":"","enabled":true,"type":"default"},{"key":"groupID_2","value":"","enabled":true,"type":"default"},{"key":"groupNestedID","value":"","enabled":true,"type":"default"},{"key":"headerValueForCustomAuthHeader","value":"","enabled":true,"type":"default"},{"key":"iconID","value":"","enabled":true,"type":"default"},{"key":"identifier","value":"","enabled":true,"type":"default"},{"key":"idpAttrID","value":"","enabled":true,"type":"default"},{"key":"idpID","value":"","enabled":true,"type":"default"},{"key":"idToken","value":"","enabled":true,"type":"default"},{"key":"imageID","value":"","enabled":true,"type":"default"},{"key":"imageUrl","value":"","enabled":true,"type":"default"},{"key":"instanceID","value":"","enabled":true,"type":"default"},{"key":"integrationID","value":"","enabled":true,"type":"default"},{"key":"integrationVersionID","value":"","enabled":true,"type":"default"},{"key":"integrityDecryptionKey","value":"","enabled":true,"type":"default"},{"key":"integrityVerificationKey","value":"","enabled":true,"type":"default"},{"key":"interactionID","value":"","enabled":true,"type":"default"},{"key":"interactionToken","value":"","enabled":true,"type":"default"},{"key":"intermediateCertificate","value":"","enabled":true,"type":"default"},{"key":"inviteCode","value":"","enabled":true,"type":"default"},{"key":"kerberosToken","value":"","enabled":true,"type":"default"},{"key":"keyID","value":"","enabled":true,"type":"default"},{"key":"krpID","value":"","enabled":true,"type":"default"},{"key":"l10nStatusID","value":"","enabled":true,"type":"default"},{"key":"languageID","value":"","enabled":true,"type":"default"},{"key":"licenseID","value":"","enabled":true,"type":"default"},{"key":"linkedAccountID","value":"","enabled":true,"type":"default"},{"key":"locale","value":"","enabled":true,"type":"default"},{"key":"loginHintJwt","value":"","enabled":true,"type":"default"},{"key":"mailFromSubdomain","value":"","enabled":true,"type":"default"},{"key":"mappingID","value":"","enabled":true,"type":"default"},{"key":"member","value":"","enabled":true,"type":"default"},{"key":"message","value":"","enabled":true,"type":"default"},{"key":"mfaPolicyID","value":"","enabled":true,"type":"default"},{"key":"nestedGroupID","value":"","enabled":true,"type":"default"},{"key":"newPassword","value":"","enabled":true,"type":"default"},{"key":"nextToken","value":"","enabled":true,"type":"default"},{"key":"nonce","value":"","enabled":true,"type":"default"},{"key":"notificationPolicyID","value":"","enabled":true,"type":"default"},{"key":"oauthAccountId","value":"","enabled":true,"type":"default"},{"key":"oauthClientId","value":"","enabled":true,"type":"default"},{"key":"oauthClientSecret","value":"","enabled":true,"type":"default"},{"key":"oauthConsentID","value":"","enabled":true,"type":"default"},{"key":"oauthToken","value":"","enabled":true,"type":"default"},{"key":"objectguid","value":"","enabled":true,"type":"default"},{"key":"orchestratePath","value":"https://orchestrate-api.pingone.{{tld}}/v1","enabled":true,"type":"default"},{"key":"orgID","value":"","enabled":true,"type":"default"},{"key":"otp","value":"","enabled":true,"type":"default"},{"key":"parentRuleID","value":"","enabled":true,"type":"default"},{"key":"password","value":"","enabled":true,"type":"default"},{"key":"passwordPolicyID","value":"","enabled":true,"type":"default"},{"key":"phoneDeliverySettingsID","value":"","enabled":true,"type":"default"},{"key":"pingAppID","value":"","enabled":true,"type":"default"},{"key":"planID","value":"","enabled":true,"type":"default"},{"key":"policyID","value":"","enabled":true,"type":"default"},{"key":"popID","value":"","enabled":true,"type":"default"},{"key":"popID-2","value":"","enabled":true,"type":"default"},{"key":"populationID","value":"","enabled":true,"type":"default"},{"key":"previousRevisionID","value":"","enabled":true,"type":"default"},{"key":"privateKey","value":"","enabled":true,"type":"default"},{"key":"privateKeyJWT","value":"","enabled":true,"type":"default"},{"key":"providerID","value":"","enabled":true,"type":"default"},{"key":"providerType","value":"","enabled":true,"type":"default"},{"key":"provisioningSyncID","value":"","enabled":true,"type":"default"},{"key":"pushCredID","value":"","enabled":true,"type":"default"},{"key":"pushToken","value":"","enabled":true,"type":"default"},{"key":"recaptchaSecretKey","value":"","enabled":true,"type":"default"},{"key":"recaptchaSiteKey","value":"","enabled":true,"type":"default"},{"key":"redirect_uri","value":"","enabled":true,"type":"default"},{"key":"refreshToken","value":"","enabled":true,"type":"default"},{"key":"refreshToken4AuthCode","value":"","enabled":true,"type":"default"},{"key":"relayState","value":"","enabled":true,"type":"default"},{"key":"requestString","value":"","enabled":true,"type":"default"},{"key":"requestURI","value":"","enabled":true,"type":"default"},{"key":"resourceAttrID","value":"","enabled":true,"type":"default"},{"key":"resourceID","value":"","enabled":true,"type":"default"},{"key":"resourceSecret","value":"","enabled":true,"type":"default"},{"key":"revisionID","value":"","enabled":true,"type":"default"},{"key":"roleAssignmentID","value":"","enabled":true,"type":"default"},{"key":"roleID","value":"","enabled":true,"type":"default"},{"key":"ruleID","value":"","enabled":true,"type":"default"},{"key":"samlAttrID","value":"","enabled":true,"type":"default"},{"key":"SAMLRequest","value":"","enabled":true,"type":"default"},{"key":"schemaAttrID","value":"","enabled":true,"type":"default"},{"key":"schemaID","value":"","enabled":true,"type":"default"},{"key":"scimPath","value":"https://scim-api.pingone.{{tld}}","enabled":true,"type":"default"},{"key":"scopeID","value":"","enabled":true,"type":"default"},{"key":"scopeID_2","value":"","enabled":true,"type":"default"},{"key":"sessionID","value":"","enabled":true,"type":"default"},{"key":"sessionToken","value":"","enabled":true,"type":"default"},{"key":"SOPAssignmentID","value":"","enabled":true,"type":"default"},{"key":"sourceStoreID","value":"","enabled":true,"type":"default"},{"key":"spEntityIdValue","value":"","enabled":true,"type":"default"},{"key":"spSigningID","value":"","enabled":true,"type":"default"},{"key":"SSHA512","value":"","enabled":true,"type":"default"},{"key":"startToken","value":"","enabled":true,"type":"default"},{"key":"state","value":"","enabled":true,"type":"default"},{"key":"storeID","value":"","enabled":true,"type":"default"},{"key":"subscriptionID","value":"","enabled":true,"type":"default"},{"key":"subToken","value":"","enabled":true,"type":"default"},{"key":"sum","value":"","enabled":true,"type":"default"},{"key":"syniverseAuthToken","value":"","enabled":true,"type":"default"},{"key":"syniverseChannelsSenderId","value":"","enabled":true,"type":"default"},{"key":"targetStoreID","value":"","enabled":true,"type":"default"},{"key":"teamID","value":"","enabled":true,"type":"default"},{"key":"templateName","value":"","enabled":true,"type":"default"},{"key":"themeID","value":"","enabled":true,"type":"default"},{"key":"to","value":"","enabled":true,"type":"default"},{"key":"token","value":"","enabled":true,"type":"default"},{"key":"trafficPolicyID","value":"","enabled":true,"type":"default"},{"key":"trustedEmailID","value":"","enabled":true,"type":"default"},{"key":"twilioVerifyAuthToken","value":"","enabled":true,"type":"default"},{"key":"twilioVerifyPhoneDeliverySettingsID","value":"","enabled":true,"type":"default"},{"key":"twilioVerifyServiceId","value":"","enabled":true,"type":"default"},{"key":"twilioVerifySid","value":"","enabled":true,"type":"default"},{"key":"uniqueId","value":"","enabled":true,"type":"default"},{"key":"urlForEmailProvider","value":"","enabled":true,"type":"default"},{"key":"userCode","value":"","enabled":true,"type":"default"},{"key":"userID","value":"","enabled":true,"type":"default"},{"key":"username","value":"","enabled":true,"type":"default"},{"key":"userPassword","value":"","enabled":true,"type":"default"},{"key":"userTypeID","value":"","enabled":true,"type":"default"},{"key":"variantName","value":"","enabled":true,"type":"default"},{"key":"verificationCode","value":"","enabled":true,"type":"default"},{"key":"whatsAppAppID","value":"","enabled":true,"type":"default"},{"key":"whatsAppBusinessID","value":"","enabled":true,"type":"default"},{"key":"whatsAppSecret","value":"","enabled":true,"type":"default"},{"key":"whatsAppToken","value":"","enabled":true,"type":"default"},{"key":"writebackStoreID","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PingOne Postman Environment Template (release: 2026-04-15)","value":"3468883-ae3973c1-110a-4773-90a0-078b32067c60"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/T17Q6jdj"}