{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a1463448-0b5c-4c33-ba26-da6e77913bb5","name":"ForgeRock Cloud APIs","description":"The ForgeRock Identity Cloud includes two sets of APIs:\n\n* Management APIs: Supports management of objects such as users.\n\n* Authentication APIs: Allows you to authenticate users into your apps.\n\nSome of these REST calls include scopes, which specify access rights as described in our documentation on <a href=\"https://developer.forgerock.com/docs/identity-cloud/tutorials/scopes\" target=\"_blank\">scopes</a>. Use that guidance to set up the scopes property in your Postman collection.\n\nThe scopes that you specify in REST calls should be included in relevant apps. When you create an app in the UI, you can identify and update these scopes under the \"API Scopes\" tab. \n\n<p>\n\nThis collection is set up with the following environment: ForgeRock Environment Vars 0.4. You can use the environment to pre-populate your REST calls. For more information, see the following section on <a href=\"https://developer.forgerock.com/docs/identity-cloud/apis/apis\" target=\"_blank\">REST APIs</a>.\n\nSome REST calls are configured to \"pre-populate\" others; for example, when you run the POST Get Web App Token - Password Grant call, the output pre-populates values for userAccessToken, refreshToken, and userIdToken. Other REST calls are configured to use these values to simplify your work.\n\nAll example commands and responses are based on cURL.\n\n<p>\n\nTo run these REST calls, you need two things:\n\n* The tenant name of your deployment. You can find it in the URL you used to sign in to the admin console: https://ui-{{name_of_your_tenant}}.forgeblocks.com/.\n* The access token you get when you sign into the admin console, available from the _developer_ options for your browser. For more information, see the following quick start page: <a href=\"https://developer.forgerock.com/docs/identity-cloud/getting-started/web-app/\" target=\"_blank\">Web App</a>.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5389909","collectionId":"a1463448-0b5c-4c33-ba26-da6e77913bb5","publishedId":"SVfRu82V","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5389909/SVfRu82V","privateUrl":"https://go.postman.co/documentation/5389909-a1463448-0b5c-4c33-ba26-da6e77913bb5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-08-30T15:46:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"ForgeRock Environment Vars 0.4","id":"3c0bac43-6c1f-45f3-af7d-61244eea03d1","owner":"5389909","values":[{"key":"tenantApiV1Url","value":"https://api-{{tenantName}}.forgeblocks.com/v1","enabled":true},{"key":"oauth2Url","value":"https://openam-{{tenantName}}.forgeblocks.com/am/oauth2","enabled":true},{"key":"authRealmsUrl","value":"https://openam-{{tenantName}}.forgeblocks.com/am/","enabled":true},{"key":"loginUrl","value":"https://example.com/homeLogin/","enabled":true},{"key":"logoutUrl","value":"https://example.com/homeLogout/","enabled":true},{"key":"tenantName","value":"{{name_of_your_tenant}}","enabled":true},{"key":"accessToken","value":"{{adminConsoleAccessToken}}","enabled":true},{"key":"appAccessToken","value":"{{web_app_access_token}}","enabled":true},{"key":"spaAppAccessToken","value":"{{spa_app_access_token}}","enabled":true},{"key":"userName","value":"{{userName}}","enabled":true},{"key":"userPassword","value":"Passwordy1#","enabled":true},{"key":"serviceClientId","value":"{{serviceClientId}}","enabled":true},{"key":"serviceClientSecret","value":"{{serviceClientSecret}}","enabled":true},{"key":"scopes","value":"me.read me.update password-policy.read password-policy.update user.reset-password user.recover-username user.create user.read openid profile email","enabled":true},{"key":"userAccessToken","value":"{{userAccessToken}}","enabled":true},{"key":"userId","value":"{{user_id}}","enabled":true},{"key":"userIdToken","value":"{{userIdToken}}","enabled":true},{"key":"userProperty","value":"userName","enabled":true},{"key":"refreshToken","value":"{{refreshToken}}","enabled":true},{"key":"code","value":"{{authCode_from_webApp}}","enabled":true},{"key":"iPlanetDirectoryPro","value":"{{iPlanetDirectoryPro_cookie}}","enabled":true},{"key":"comparator","value":"{{comparator}}","enabled":true},{"key":"value","value":"{{valueOfFilter}}","enabled":true},{"key":"parameter","value":"{{filterType}}","enabled":true},{"key":"m2mAppClientId","value":"{{client_id_of_spa_app}}","enabled":true},{"key":"m2mAppClientSecret","value":"{{m2mSpaClientSecret}}","enabled":true},{"key":"webAppClientId","value":"{{client_id_of_web_app}}","enabled":true},{"key":"webAppClientSecret","value":"{{client_secret_of_web_app))","enabled":true},{"key":"spaAppClientId","value":"{{spa_app_client_id}}","enabled":true},{"key":"spaAppClientSecret","value":"{{spa_app_client_secret}}","enabled":true},{"key":"authorizationCode","value":"{{PKCE_based}}","enabled":true},{"key":"authTree","value":"{{authentication_tree}}","enabled":true},{"key":"ssoToken","value":"{{iPlanetDirectoryPro}}","enabled":true},{"key":"spaScopes","value":"me.read me.update password-policy.read password-policy.update user.reset-password user.recover-username user.create user.read openid profile email","enabled":true}],"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":"ForgeRock Environment Vars 0.4","value":"5389909-3c0bac43-6c1f-45f3-af7d-61244eea03d1"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SVfRu82V"}