{"info":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","description":"

The ForgeRock Identity Cloud includes two sets of APIs:

\n\n

For descriptions of environment variables, see our glossary of Postman Variables.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2524838","collectionId":"c0a342ab-034d-42d6-ac8d-d321095aa313","publishedId":"SW11XeCP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-30T16:56:06.000Z"},"item":[{"name":"Management APIs","item":[{"name":"Apps","item":[{"name":"Apps and Tokens","item":[{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"446df8ac-6ada-41a3-81b5-1bfd7e092068","exec":["var json = JSON.parse(responseBody);","","if (json.token) { "," pm.environment.set(\"accessToken\",json.token);","}"],"type":"text/javascript"}}],"id":"dac5ecf8-b3a4-4306-860f-e8f0f086ef95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{teamMemberName}}\",\n \"password\":\"{{teamMemberPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/auth/signin","description":"

Get the access_token for your tenant. Used in subsequent REST calls.

\n","urlObject":{"path":["auth","signin"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"3ea941e8-f8cb-4d25-999a-c154b4b1f03b","name":"Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{teamMemberName}}\",\n \"password\":\"{{teamMemberPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/auth/signin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"526"},{"key":"ETag","value":"W/\"20e-Lp03K81+ujCr3lPKGsT93pO6yNk\""},{"key":"Date","value":"Mon, 09 Sep 2019 22:31:35 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"expires\": \"2019-09-09T23:31:35+00:00\",\n \"token\": \"\",\n \"user\": {\n \"email\": \"team.member@example.com\",\n \"firstName\": \"Team\",\n \"lastName\": \"Member\",\n \"session\": \"129d5eee-300d-49c9-b80d-06bacecb79db\"\n }\n}"}],"_postman_id":"dac5ecf8-b3a4-4306-860f-e8f0f086ef95"},{"name":"Get Apps","id":"9499a6c7-a082-4b18-b381-99726f986c4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{tenantApiV1Url}}/apps","description":"

Retreives details for all configured apps in Express

\n","urlObject":{"path":["apps"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"496fa7a4-e187-45b3-8277-8bff22614107","name":"Get Apps","originalRequest":{"method":"GET","header":[],"url":"{{tenantApiV1Url}}/apps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2802"},{"key":"ETag","value":"W/\"af2-nEhgAva65TnIezVMDEPM41R/O5M\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:45:52 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"user.update\",\n \"app.delete\",\n \"app.update\",\n \"app.create\",\n \"app.refresh-secret\",\n \"email-template.update\",\n \"hosted-page-config.update\",\n \"email-template.read\",\n \"hosted-page-config.read\",\n \"user.delete\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"608e7bcf38817bf51ba1bcb728b0b3e1\",\n \"customClaims\": {},\n \"description\": \"An updated M2M app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Express Default App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"m2m\"\n },\n {\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"d476a3d687d6e875f967ac15ca17a04c\",\n \"customClaims\": {},\n \"description\": \"My super awesome app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n },\n {\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"04a02654cc28e661e3fea3e42d9af20e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"m2m\"\n },\n {\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"4c208861c2027de1b7c51320329c0d92\",\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"web\"\n }\n]"}],"_postman_id":"9499a6c7-a082-4b18-b381-99726f986c4b"},{"name":"Get App","id":"a41d755d-f5ec-436a-8a91-30383887bc2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{tenantApiV1Url}}/apps/{{clientId}}","description":"

Retreives configuration details of of a specific applicatiion. Set the clientId parameter to the clientId of the app configuration you want to retrieve.

\n","urlObject":{"path":["apps","{{clientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"71e3befe-af56-4a38-b392-04aa06082358","name":"Get App","originalRequest":{"method":"GET","header":[],"url":"{{tenantApiV1Url}}/apps/{{clientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"574"},{"key":"ETag","value":"W/\"23e-Hj/WRqt8lCmAUFC8UzL8CgvDdyg\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:21:18 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"dad2bb835aa7d9d768c469964ef5679e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"m2m\"\n}"}],"_postman_id":"a41d755d-f5ec-436a-8a91-30383887bc2d"}],"id":"6e067113-6f66-4cba-b333-145a567ce252","_postman_id":"6e067113-6f66-4cba-b333-145a567ce252","description":"","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Native/Spa Apps","item":[{"name":"Create a Native/SPA App","event":[{"listen":"test","script":{"id":"1fd2a55a-d732-4e0e-ba83-6f594d33b7df","exec":["var json = JSON.parse(responseBody);","","if (json.clientId) { "," pm.environment.set(\"natspaClientId\",json.clientId);"," pm.environment.set(\"clientId\",json.clientId);"," console.log(`set clientId = ${json.clientId}`);"," console.log(`set natspaClientId = ${json.clientId}`);","}"],"type":"text/javascript"}}],"id":"93d13bec-a482-4eb4-a81c-fb81676fcbed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My super awesome app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}\n"},"url":"{{tenantApiV1Url}}/apps","description":"

Creates a Native/SPA app. Returns the app configururation.

\n

The reponse contains a client ID to be used when authenticating a user to this application. Because Native and SPA apps are unable to protect a secret, a secret is not used when authentication with this type of app.

\n

Include: \"type\" : \"spa\" in the payload to specify the type of app to be created in Express

\n","urlObject":{"path":["apps"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"f8fa53bf-66a3-445f-9313-7ecce5744b5c","name":"Create a Native/SPA App","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My super awesome app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}\n"},"url":"{{tenantApiV1Url}}/apps"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"680"},{"key":"ETag","value":"W/\"2a8-gD12tasnaLeq264ct3/QaPvhbH4\""},{"key":"Date","value":"Wed, 24 Jul 2019 14:55:02 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"5bcb17fb103915434126e09086e40e7e\",\n \"customClaims\": {},\n \"description\": \"My super awesome app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}"}],"_postman_id":"93d13bec-a482-4eb4-a81c-fb81676fcbed"},{"name":"Update Native/SPA App","event":[{"listen":"test","script":{"id":"b8055a85-9dc6-4c97-abbb-3a3d7dd2febf","exec":[""],"type":"text/javascript"}}],"id":"93fbbf4b-3ba6-4259-9dcb-b41922d084f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{natspaClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great sample app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{natspaClientId}}","description":"

Updates the configuration of an existing Native/SPA application client

\n","urlObject":{"path":["apps","{{natspaClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"7bde2120-2bdf-4992-b3e4-8d0c00e63253","name":"Update Native/SPA App","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{natspaClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great sample app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{natspaClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"689"},{"key":"ETag","value":"W/\"2b1-sndDnrs5EADeRfuUBgXxuza484w\""},{"key":"Date","value":"Wed, 24 Jul 2019 14:55:19 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"5bcb17fb103915434126e09086e40e7e\",\n \"customClaims\": {},\n \"description\": \"My great sample app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}"}],"_postman_id":"93fbbf4b-3ba6-4259-9dcb-b41922d084f0"},{"name":"Delete Native/SPA App","id":"8773e218-cef4-4ec4-847c-cc42e6ea58b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{natspaClientId}}","description":"

Deletes an app as specified by its Client ID

\n","urlObject":{"path":["apps","{{natspaClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"29a115e9-23da-4ce2-9d7b-b3f6ee7158de","name":"Delete Native/SPA App","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{natspaClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"689"},{"key":"ETag","value":"W/\"2b1-sndDnrs5EADeRfuUBgXxuza484w\""},{"key":"Date","value":"Wed, 24 Jul 2019 14:55:38 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"5bcb17fb103915434126e09086e40e7e\",\n \"customClaims\": {},\n \"description\": \"My great sample app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Native/Spa App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"spa\"\n}"}],"_postman_id":"8773e218-cef4-4ec4-847c-cc42e6ea58b3"}],"id":"5f70ac1e-caaf-442d-a80c-a8d177b5ebc2","description":"

Create, update, and delete Native/SPA apps. The OAuth 2.0 spec calls these apps public apps because they are unable to protect a client secret.

\n

Each time you create a new Native/SPA app in Express, our test script will store the public client ID in a postman variable natspaClientId and clientId, which is used by the other API calles in the Native/Spa Apps collection.

\n","event":[{"listen":"prerequest","script":{"id":"f3b75fd1-53c8-424b-add6-5113cb800579","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b767f784-57a8-44ae-8cfc-82da5b054b02","type":"text/javascript","exec":[""]}}],"_postman_id":"5f70ac1e-caaf-442d-a80c-a8d177b5ebc2","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Web Apps: Base64 Encoded Client ID and Secret","item":[{"name":"Create a New Web App ","event":[{"listen":"test","script":{"id":"1fd2a55a-d732-4e0e-ba83-6f594d33b7df","exec":["var json = JSON.parse(responseBody);","if(json.clientId){","postman.setEnvironmentVariable(\"webClientId\", json.clientId);","postman.setEnvironmentVariable(\"clientId\", json.clientId);","console.log(`set clientId = ${json.clientId}`);","console.log(`set webClientId = ${json.clientId}`);","","}","if(json.secret){","postman.setEnvironmentVariable(\"webSecret\", json.secret);","console.log(`set webSecret = ${json.secret}`);","}"],"type":"text/javascript"}}],"id":"054410e6-f8bd-4489-8abc-bb8cff6ca88a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true,\n \"clientCredentials\": true,\n \"password\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps","description":"

Creates a web app client in Express .

\n

Include: \"type\" : \"web\" in the payload to specify the type of app to be created in Express

\n

Note: In this example call the password client grant type to true. Use password client grant for non-production environments and use authorization code or client crendial grants for production.

\n","urlObject":{"path":["apps"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"815aaecc-992c-4c0f-982a-e9bd772875ca","name":"Create a New Web App ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true,\n \"clientCredentials\": true,\n \"password\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"882"},{"key":"ETag","value":"W/\"372-YjwrSTeK4FaqwukwBFeP5KC6Tq0\""},{"key":"Date","value":"Tue, 08 Oct 2019 15:59:04 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\": {\n \"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"978a35beab66a40d5e59d964fef09f1f\",\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"uYCx/9aGUgwTrPiM2hrsgI2zl71YNerz0TWVqhrNZ0c=\",\n \"type\": \"web\"\n}"}],"_postman_id":"054410e6-f8bd-4489-8abc-bb8cff6ca88a"},{"name":"Update Web App","event":[{"listen":"test","script":{"id":"b8055a85-9dc6-4c97-abbb-3a3d7dd2febf","exec":[""],"type":"text/javascript"}}],"id":"634ffcd0-22b7-4fdc-9e77-490278e64435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{webClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}","description":"

Updates the configuration of an existing web application client.

\n","urlObject":{"path":["apps","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"e3255757-284f-44ac-add2-457904577961","name":"Update Web App","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{webClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"829"},{"key":"ETag","value":"W/\"33d-wu6DkI7cjjOtogEhk1j9nSk9lMo\""},{"key":"Date","value":"Tue, 08 Oct 2019 15:59:57 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\": {\n \"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"978a35beab66a40d5e59d964fef09f1f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"web\"\n}"}],"_postman_id":"634ffcd0-22b7-4fdc-9e77-490278e64435"},{"name":"Regenerate Web App Secret","event":[{"listen":"test","script":{"id":"0fe62f1e-348b-4353-bcb1-efa0a1cdce26","exec":[""],"type":"text/javascript"}}],"id":"f0108d2c-2962-44ad-95ed-8f0b3f1edf38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{webClientId}}","description":"

Generates a new client secret for the app. To successfully refresh the app secret you must ensure the access token you use has the app.refresh-secret scope set.

\n","urlObject":{"path":["apps","refresh","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"0b134fdf-e7a3-4e0d-8b17-ddcb0c46947f","name":"Regenerate Web App Secret","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"800"},{"key":"ETag","value":"W/\"320-NwZqnRTOHWcffR/y97h38V4X6So\""},{"key":"Date","value":"Wed, 24 Jul 2019 14:58:54 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"0df4ae802cd048ed1bafef2ba84be79f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Top Foods\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"ZIVij4RIbUnIiKFwtvZoG93rkTlRooXIkapzWzxexFI=\",\n \"type\": \"web\"\n}"}],"_postman_id":"f0108d2c-2962-44ad-95ed-8f0b3f1edf38"},{"name":"Delete Web App","id":"1ff44dfa-a965-46e9-a225-e0572df715a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}","description":"

Deletes an app as specified by its client ID.

\n","urlObject":{"path":["apps","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"749e3fcd-006f-4fa6-9fa5-2d55f43d5cc2","name":"Delete Web App","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"758"},{"key":"ETag","value":"W/\"2f6-LK56EAJrw9bOzinKTT4W233/taA\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:01:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"0df4ae802cd048ed1bafef2ba84be79f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Top Foods\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"web\"\n}"}],"_postman_id":"1ff44dfa-a965-46e9-a225-e0572df715a3"}],"id":"5ad2f4d0-1e8a-4a77-84b8-a8640c4865c3","description":"

You can create, update, and delete, and regenerate a client secret Web apps. The OAuth 2.0 spec calls these apps as confidential apps because they are able to store their client secret.

\n

These commands use the posted version of your client ID and client secret, based on the client_secret_basic Token Endpoint Authentication Method listed in RFC7591.

\n

Each time you create a new Web app in Express, our test script will store the public client ID and secret in the postman variables webClientId,webSecret, and cliendId which are used by other API calles in the Web Apps collection.

\n","event":[{"listen":"prerequest","script":{"id":"dde5d636-2f65-436a-a0f4-a463ba19c747","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f0ea78d1-7fc8-47de-8529-ff999359c362","type":"text/javascript","exec":[""]}}],"_postman_id":"5ad2f4d0-1e8a-4a77-84b8-a8640c4865c3","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Web Apps: Posted Client ID and Secret","item":[{"name":"Create a New Web App ","event":[{"listen":"test","script":{"id":"1fd2a55a-d732-4e0e-ba83-6f594d33b7df","exec":["var json = JSON.parse(responseBody);","if(json.clientId){","postman.setEnvironmentVariable(\"webClientId\", json.clientId);","postman.setEnvironmentVariable(\"clientId\", json.clientId);","console.log(`set clientId = ${json.clientId}`);","console.log(`set webClientId = ${json.clientId}`);","","}","if(json.secret){","postman.setEnvironmentVariable(\"webSecret\", json.secret);","console.log(`set webSecret = ${json.secret}`);","}"],"type":"text/javascript"}}],"id":"2fc63e5c-cff5-4cfb-b55e-3afb0c3a7a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_post\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true,\n \"clientCredentials\": true,\n \"password\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps","description":"

Creates a web app client in Express .

\n

Include: \"type\" : \"web\" in the payload to specify the type of app to be created in Express

\n

Note: In this example call the password client grant type to true. Use password client grant for non-production environments and use authorization code or client crendial grants for production.

\n","urlObject":{"path":["apps"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"695ba506-9a2c-4f5b-a208-fbe1f5fdbd8e","name":"Create a New Web App ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"refreshToken\": true,\n \"clientCredentials\": true,\n \"password\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\"https://example.com/homeLogin/\"],\n \"logoutRedirectUris\": [\"https://example.com/homeLogout/\"],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"882"},{"key":"ETag","value":"W/\"372-YjwrSTeK4FaqwukwBFeP5KC6Tq0\""},{"key":"Date","value":"Tue, 08 Oct 2019 15:59:04 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\": {\n \"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"me.update-password\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"978a35beab66a40d5e59d964fef09f1f\",\n \"customClaims\": {},\n \"description\": \"My great sample web app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://example.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"uYCx/9aGUgwTrPiM2hrsgI2zl71YNerz0TWVqhrNZ0c=\",\n \"type\": \"web\"\n}"}],"_postman_id":"2fc63e5c-cff5-4cfb-b55e-3afb0c3a7a6f"},{"name":"Update Web App","event":[{"listen":"test","script":{"id":"b8055a85-9dc6-4c97-abbb-3a3d7dd2febf","exec":[""],"type":"text/javascript"}}],"id":"22f69c22-dca3-4055-84ce-a3e8ab339a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{webClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}","description":"

Updates the configuration of an existing web application client.

\n","urlObject":{"path":["apps","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"a8785eef-607c-44be-b9da-7ebc1f6d8675","name":"Update Web App","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\" : {\n \t\"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{webClientId}}\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"web\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"829"},{"key":"ETag","value":"W/\"33d-wu6DkI7cjjOtogEhk1j9nSk9lMo\""},{"key":"Date","value":"Tue, 08 Oct 2019 15:59:57 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"advancedOAuth\": {\n \"tokenEndpointAuthMethod\": \"client_secret_basic\"\n },\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"978a35beab66a40d5e59d964fef09f1f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Sample Web App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"web\"\n}"}],"_postman_id":"22f69c22-dca3-4055-84ce-a3e8ab339a54"},{"name":"Regenerate Web App Secret","event":[{"listen":"test","script":{"id":"0fe62f1e-348b-4353-bcb1-efa0a1cdce26","exec":[""],"type":"text/javascript"}}],"id":"d23a6627-2003-4258-8ece-3f523ee1eaf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{webClientId}}","description":"

Generates a new client secret for the app. To successfully refresh the app secret you must ensure the access token you use has the app.refresh-secret scope set.

\n","urlObject":{"path":["apps","refresh","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"21656836-b138-4806-9739-fca5bf0b98a7","name":"Regenerate Web App Secret","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"800"},{"key":"ETag","value":"W/\"320-NwZqnRTOHWcffR/y97h38V4X6So\""},{"key":"Date","value":"Wed, 24 Jul 2019 14:58:54 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"0df4ae802cd048ed1bafef2ba84be79f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Top Foods\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"ZIVij4RIbUnIiKFwtvZoG93rkTlRooXIkapzWzxexFI=\",\n \"type\": \"web\"\n}"}],"_postman_id":"d23a6627-2003-4258-8ece-3f523ee1eaf5"},{"name":"Delete Web App","id":"fadf175c-b189-4ea0-933d-c4bec4e01035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}","description":"

Deletes an app as specified by its client ID.

\n","urlObject":{"path":["apps","{{webClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"dc9e7f47-eb16-4e12-b33f-da46fce2c9e2","name":"Delete Web App","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{webClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"758"},{"key":"ETag","value":"W/\"2f6-LK56EAJrw9bOzinKTT4W233/taA\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:01:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"me.read\",\n \"me.update\",\n \"password-policy.read\",\n \"password-policy.update\",\n \"user.reset-password\",\n \"user.recover-username\",\n \"user.create\",\n \"user.read\",\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"0df4ae802cd048ed1bafef2ba84be79f\",\n \"customClaims\": {},\n \"description\": \"My great web service app, modfied\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"authorizationCode\": true,\n \"clientCredentials\": true,\n \"password\": true,\n \"refreshToken\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [\n \"https://example.com/homeLogin/\"\n ],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [\n \"https://exmaple.com/homeLogout/\"\n ],\n \"name\": \"Top Foods\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"web\"\n}"}],"_postman_id":"fadf175c-b189-4ea0-933d-c4bec4e01035"}],"id":"9f6c1a14-03c4-490e-b0f4-b3b25f88d8a4","description":"

You can create, update, and delete, and regenerate a client secret Web apps. The OAuth 2.0 spec calls these apps as confidential apps because they are able to store their client secret.

\n

These commands use the posted version of your client ID and client secret, based on the client_secret_post Token Endpoint Authentication Method listed in RFC7591.

\n

Each time you create a new Web app in Express, our test script will store the public client ID and secret in the postman variables webClientId,webSecret, and cliendId which are used by other API calles in the Web Apps collection.

\n","event":[{"listen":"prerequest","script":{"id":"dde5d636-2f65-436a-a0f4-a463ba19c747","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f0ea78d1-7fc8-47de-8529-ff999359c362","type":"text/javascript","exec":[""]}}],"_postman_id":"9f6c1a14-03c4-490e-b0f4-b3b25f88d8a4","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Service (M2M) App","item":[{"name":"Create a New Service (M2M) App","event":[{"listen":"test","script":{"id":"1fd2a55a-d732-4e0e-ba83-6f594d33b7df","exec":["var json = JSON.parse(responseBody);","if(json.clientId){","postman.setEnvironmentVariable(\"m2mClientId\", json.clientId);","postman.setEnvironmentVariable(\"clientId\", json.clientId);","console.log(`set clientId = ${json.clientId}`);","console.log(`set m2mClientId = ${json.clientId}`);","","}","if(json.secret){","postman.setEnvironmentVariable(\"m2mSecret\", json.secret);","console.log(`set m2mSecret = ${json.secret}`);","}"],"type":"text/javascript"}}],"id":"3140c38c-63ac-41f7-a948-7ead346543fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My super sample service app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"type\" : \"m2m\"\n}"},"url":"{{tenantApiV1Url}}/apps","description":"

Creates a Service app in Express

\n

Include: \"type\" : \"m2m\" in the payload to specify the type of app to be created in Express and set \"clientCredentials\" : \"true\"

\n

Each time you create a new Web app in Express, our test script will store the public client ID and secret in the postman variables m2mClientId and m2mSecret, which are used by other API calles in the Serivce (M2M) Apps collection.

\n","urlObject":{"path":["apps"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"5a3b447a-abd0-4da2-9f24-800799a912bb","name":"Create a New Service (M2M) App","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"customClaims\": {},\n \"description\": \"My super sample service app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"type\" : \"m2m\"\n}"},"url":"{{tenantApiV1Url}}/apps"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"616"},{"key":"ETag","value":"W/\"268-aanpbjVGO9YXUxEcFWafoLabunQ\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:13:01 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"3e322f0f0f6250addbb107b2b610ae2e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"mUtnkAuxqlNgptC6BZPOLIAMGgDJJis3fwx2k1pEqLc=\",\n \"type\": \"m2m\"\n}"}],"_postman_id":"3140c38c-63ac-41f7-a948-7ead346543fc"},{"name":"Update Service (M2M) App","event":[{"listen":"test","script":{"id":"b8055a85-9dc6-4c97-abbb-3a3d7dd2febf","exec":[""],"type":"text/javascript"}}],"id":"b0356114-50e0-4b01-bba9-2e7314c4cf4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{m2mClientId}}\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"m2m\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{m2mClientId}}","description":"

Updates the configuration of an existing service app.

\n","urlObject":{"path":["apps","{{m2mClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"8b6f6835-2c27-48d2-b0a6-65bb51566c1d","name":"Update Service (M2M) App","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"{{m2mClientId}}\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"type\": \"m2m\"\n}"},"url":"{{tenantApiV1Url}}/apps/{{m2mClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"584"},{"key":"ETag","value":"W/\"248-zLx+fv3tugVT7x/2DvL/GTd4VpE\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:13:11 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"3e322f0f0f6250addbb107b2b610ae2e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"m2m\"\n}"}],"_postman_id":"b0356114-50e0-4b01-bba9-2e7314c4cf4f"},{"name":"Regenerate Service (M2M) App Secret","event":[{"listen":"test","script":{"id":"f3d64771-7587-43be-9073-466b775380bc","exec":[""],"type":"text/javascript"}}],"id":"1a1cdaf3-351a-4794-8fd2-f1ad550b28e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{m2mClientId}}","description":"

Generates a new client secret for the app. To successfully refresh the app secret you must ensure the access token you use has the app.refresh-secret scope set

\n","urlObject":{"path":["apps","refresh","{{m2mClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"da767bdc-9ec4-40c1-aef3-3c947b85d5c9","name":"Regenerate Service (M2M) App Secret","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/refresh/{{m2mClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"626"},{"key":"ETag","value":"W/\"272-Zxdj6mN4K5oIAGGS8b5nm/OyEWc\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:13:22 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"3e322f0f0f6250addbb107b2b610ae2e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": \"AV2tlwJ2Ew3NcWPLI3rPYvw4dSPH2jbOk1wxTeM2knE=\",\n \"type\": \"m2m\"\n}"}],"_postman_id":"1a1cdaf3-351a-4794-8fd2-f1ad550b28e9"},{"name":"Delete Service (M2M) App","id":"dc9ccf03-364c-4505-a5ad-cafa5474195d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{m2mClientId}}","description":"

Deletes an app as specified by its Client ID

\n","urlObject":{"path":["apps","{{m2mClientId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"99b6466d-68a0-4aec-9833-331a15308330","name":"Delete Service (M2M) App","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/apps/{{m2mClientId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"584"},{"key":"ETag","value":"W/\"248-zLx+fv3tugVT7x/2DvL/GTd4VpE\""},{"key":"Date","value":"Wed, 24 Jul 2019 15:13:33 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accessTokenLifetime\": 3600,\n \"apiScopes\": [\n \"app.read\",\n \"app.update\",\n \"hosted-page-config.read\",\n \"hosted-page-config.update\",\n \"password-policy.read\",\n \"password-policy.update\"\n ],\n \"authorizationCodeLifetime\": 120,\n \"clientId\": \"3e322f0f0f6250addbb107b2b610ae2e\",\n \"customClaims\": {},\n \"description\": \"My super sample service app, modified\",\n \"domain\": \"\",\n \"enabled\": true,\n \"grantTypes\": {\n \"clientCredentials\": true\n },\n \"jwtSigningAlgorithm\": \"RS256\",\n \"jwtTokenLifetime\": 3600,\n \"loginRedirectUris\": [],\n \"logoUrl\": \"\",\n \"logoutRedirectUris\": [],\n \"name\": \"Sample Service App\",\n \"refreshTokenLifetime\": 604800,\n \"secret\": null,\n \"type\": \"m2m\"\n}"}],"_postman_id":"dc9ccf03-364c-4505-a5ad-cafa5474195d"}],"id":"c9d059ec-0e75-4006-85a1-bb34e84f9119","description":"

Create, update, and delete, and refresh the client secrest for Service apps called M2M apps in Express . Machine to Machine apps are categorized as confidential clients due to their ability to store the client secret.

\n

Each time you create a new M2M app in Express, our test script will store the m2m client ID and secret in the postman variables m2mClientId and m2mSecret, which are used by other API calls in the M2M Apps collection.

\n","event":[{"listen":"prerequest","script":{"id":"ca5727af-175e-4b3e-b64d-2cb31c0b404f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ebeccdb-917b-46de-83b9-dd4d7db302c6","type":"text/javascript","exec":[""]}}],"_postman_id":"c9d059ec-0e75-4006-85a1-bb34e84f9119","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}}],"id":"78e49aab-1ba6-49b2-9d54-66688ff8adf0","description":"

Configure, create, and manage applications profiles in Express . Using the client id and in the case of confidentiial clients the secret, you will be able to generate an access token for these apps using the Authentication APIs.

\n","event":[{"listen":"prerequest","script":{"id":"cc76edb6-f54d-4d03-b895-66aafa05f0cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a60a22bc-fd4d-428c-bd23-a3141787329a","type":"text/javascript","exec":[""]}}],"_postman_id":"78e49aab-1ba6-49b2-9d54-66688ff8adf0","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Users","item":[{"name":"Create user","event":[{"listen":"test","script":{"id":"4fd89a1d-1a41-4692-9c2a-a09ac9c2cbed","exec":["var json = JSON.parse(responseBody);","if(json.id){","postman.setEnvironmentVariable(\"userId\", json.id);","console.log(`set userId = ${json.id}`);","}","if(json.userName){","postman.setEnvironmentVariable(\"userName\", json.userName);","console.log(`set userName = ${json.userName}`);","}"],"type":"text/javascript"}}],"id":"ab7b77b4-535a-4a2a-8961-d7792be7ea4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"externalId\": \"701985\",\n \"userName\": \"bjensen@example.com\",\n \"accountVerified\": true,\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"displayName\": \"Babs Jensen\",\n \"nickName\": \"Babs\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": true\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"userType\": \"Customer\",\n \"title\": \"Master Carpenter\",\n \"preferredLanguage\": \"en-US\",\n \"locale\": \"en-US\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"password\": \"{{userPassword}}\",\n \"destinationUrl\": \"http://destiantion-following-email-validation.com\"\n }\n"},"url":"{{tenantApiV1Url}}/users","description":"

Creates a new end user. Returns the profile of the created user and generates the id of the user.

\n

When the password policy is required for email validation the destinationUrl must be specified in the payload of this request.

\n

Each time you create a new user in Express, our test script will store the userId and username in the postman variables userId and userName, which are used by other API calls in the Users collection as well as authentication collection

\n","urlObject":{"path":["users"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"9af816d1-3932-4335-816a-f8970aa2f874","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"externalId\": \"701985\",\n \"userName\": \"bjensen@example.com\",\n \"accountVerified\": true,\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"displayName\": \"Babs Jensen\",\n \"nickName\": \"Babs\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": true\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"userType\": \"Customer\",\n \"title\": \"Master Carpenter\",\n \"preferredLanguage\": \"en-US\",\n \"locale\": \"en-US\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"password\": \"{{userPassword}}\",\n \"destinationUrl\": \"http://destiantion-following-email-validation.com\"\n }\n"},"url":"{{tenantApiV1Url}}/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1282"},{"key":"ETag","value":"W/\"502-1GMVTRc/QX8A2k4PWuyR0o6oVzU\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:48:21 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:48:19.427586Z\"\n }\n}"}],"_postman_id":"ab7b77b4-535a-4a2a-8961-d7792be7ea4d"},{"name":"Create user, with custom attributes","event":[{"listen":"test","script":{"id":"4fd89a1d-1a41-4692-9c2a-a09ac9c2cbed","exec":["var json = JSON.parse(responseBody);","if(json.id){","postman.setEnvironmentVariable(\"userId\", json.id);","console.log(`set userId = ${json.id}`);","}","if(json.userName){","postman.setEnvironmentVariable(\"userName\", json.userName);","console.log(`set userName = ${json.userName}`);","}"],"type":"text/javascript"}}],"id":"b4b14f73-3765-4b70-8c05-97061ddfd1d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"externalId\": \"701985\",\n \"userName\": \"bjensen@example.com\",\n \"accountVerified\": true,\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"displayName\": \"Babs Jensen\",\n \"nickName\": \"Babs\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": true\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"userType\": \"Customer\",\n \"title\": \"Master Carpenter\",\n \"preferredLanguage\": \"en-US\",\n \"locale\": \"en-US\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"password\": \"{{userPassword}}\",\n \"destinationUrl\": \"http://destiantion-following-email-validation.com\",\n \"custom\" : {\n \t\"somethingOld\" : \"desiredValue\",\n \t\"somethingNew\" : [\n \t\t\"valueOne\",\n \t\t\"valueTwo\"\n \t\t],\n \t\"somethingBorrowed\" : {\n \t\t\"objectField\" : \"objectValue\"\n \t},\n \t\"somethingBlue\": true,\n \t\"someNumber\": 1000\n }\n }\n"},"url":"{{tenantApiV1Url}}/users","description":"

Creates a new end user. Returns the profile of the created user and generates the id of the user.

\n

This example includes custom attributes, in the following JSON Blob:

\n
    \"custom\": {\n        \"somethingOld\": \"desiredValue\",\n        \"somethingNew\": [\n            \"valueOne\",\n            \"valueTwo\"\n        ],\n        \"somethingBorrowed\": {\n            \"objectField\": \"objectValue\"\n        },\n        \"somethingBlue\": \"yourEntry\",\n        \"somethingMore\": \"oneFineDay\"\n    },\n\n
\n

If you choose to use custom attributes, the only required property in this JSON Blob is custom.

\n","urlObject":{"path":["users"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"01cfd3fc-1d9d-4463-a6d5-3bba5b911b72","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"externalId\": \"701985\",\n \"userName\": \"bjensen@example.com\",\n \"accountVerified\": true,\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"displayName\": \"Babs Jensen\",\n \"nickName\": \"Babs\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": true\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"userType\": \"Customer\",\n \"title\": \"Master Carpenter\",\n \"preferredLanguage\": \"en-US\",\n \"locale\": \"en-US\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"password\": \"{{userPassword}}\",\n \"destinationUrl\": \"http://destiantion-following-email-validation.com\"\n }\n"},"url":"{{tenantApiV1Url}}/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1282"},{"key":"ETag","value":"W/\"502-1GMVTRc/QX8A2k4PWuyR0o6oVzU\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:48:21 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:48:19.427586Z\"\n }\n}"}],"_postman_id":"b4b14f73-3765-4b70-8c05-97061ddfd1d1"},{"name":"Get user","event":[{"listen":"test","script":{"id":"05d1599b-0381-4624-a543-dea85637de9b","exec":[""],"type":"text/javascript"}}],"id":"65f77e19-e0fd-4d98-8ec3-e0718ede98b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{tenantApiV1Url}}/users/{{userId}}","description":"

Retreives details of the user as specified by user's id

\n","urlObject":{"path":["users","{{userId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"a0677d25-28e7-478e-88a1-1e9c4d796952","name":"Get user","originalRequest":{"method":"GET","header":[],"url":"{{tenantApiV1Url}}/users/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1282"},{"key":"ETag","value":"W/\"502-1GMVTRc/QX8A2k4PWuyR0o6oVzU\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:49:05 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:48:19.427586Z\"\n }\n}"}],"_postman_id":"65f77e19-e0fd-4d98-8ec3-e0718ede98b1"},{"name":"Update user","event":[{"listen":"test","script":{"id":"e4caebed-e3ad-4dd7-a989-39a1b2401116","exec":[""],"type":"text/javascript"}}],"id":"64b88abb-4783-4772-bd0e-f78ef5983248","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"postalCode\": \"94703\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 94703 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5553\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"accountStatus\": \"Active\"\n}"},"url":"{{tenantApiV1Url}}/users/{{userId}}","description":"

Updates properties for the specified user.

\n","urlObject":{"path":["users","{{userId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"bab5bb06-73fa-4708-945c-82c17897d850","name":"Update user","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"postalCode\": \"94703\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 94703 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5553\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"accountStatus\": \"Active\"\n}"},"url":"{{tenantApiV1Url}}/users/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1286"},{"key":"ETag","value":"W/\"506-I8MG1q1o3xDGfyrHHKMYbNAho4M\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:49:43 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n },\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"postalCode\": \"94703\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 94703 USA\",\n \"primary\": true\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n },\n {\n \"value\": \"555-555-5553\",\n \"type\": \"work\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:49:43.660688Z\"\n }\n}"}],"_postman_id":"64b88abb-4783-4772-bd0e-f78ef5983248"},{"name":"Delete user","id":"3d5734b0-7796-443c-9843-48f5bf58c340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/users/{{userId}}","description":"

Deletes the user by {{userId}}. Returns the profile of the deleted user.

\n","urlObject":{"path":["users","{{userId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"b49b4756-3fa7-4566-8d7a-f5f9c85f0299","name":"Delete user","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/users/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1188"},{"key":"ETag","value":"W/\"4a4-k9FlCQiK3YzFMMiYUeJtf52Z+vQ\""},{"key":"Date","value":"Sun, 21 Jul 2019 14:55:39 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"cfbce36e-e698-4758-9506-3527ae9190d2\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": []\n}"}],"_postman_id":"3d5734b0-7796-443c-9843-48f5bf58c340"},{"name":"Get users ","event":[{"listen":"test","script":{"id":"570678be-7344-4365-83fa-236eeff8b588","exec":[""],"type":"text/javascript"}}],"id":"778c4fb4-f001-4911-a4fa-246a2973c1da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{tenantApiV1Url}}/users","description":"

Returns a paged list of end users. You can limit output based on filters and parameters, as discussed in our documentation on Querying Users.

\n","urlObject":{"path":["users"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"d7f75a2d-8c0f-41d3-9857-e65456ae80c9","name":"Get users ","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{tenantApiV1Url}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2705"},{"key":"ETag","value":"W/\"a91-84tJTCDLYrIr5DfB9ljV3u9MeRA\""},{"key":"Date","value":"Thu, 25 Jul 2019 14:53:26 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n ],\n \"Resources\": [\n {\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n },\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"postalCode\": \"94703\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 94703 USA\",\n \"primary\": true\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n },\n {\n \"value\": \"555-555-5553\",\n \"type\": \"work\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:49:43.660688Z\"\n }\n },\n {\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"streetAddress\": \"123 Sunrise Rd\",\n \"locality\": \"Dallas\",\n \"postalCode\": \"12345\",\n \"country\": \"US\",\n \"region\": \"Texas\"\n }\n ],\n \"displayName\": \"\",\n \"emails\": [\n {\n \"value\": \"roger.smith@example.com\",\n \"verified\": false\n }\n ],\n \"id\": \"aac63810-aac4-4933-9636-d0bb6d27cad2\",\n \"ims\": [],\n \"locale\": \"\",\n \"name\": {\n \"familyName\": \"Smith\",\n \"givenName\": \"Roger\"\n },\n \"nickName\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"(444) 555-6666\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"\",\n \"profileUrl\": \"\",\n \"timezone\": \"\",\n \"title\": \"\",\n \"userName\": \"RogerSmith\",\n \"userType\": \"\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:51:29.589040Z\",\n \"lastModified\": \"2019-07-25T14:51:29.589145Z\"\n }\n },\n {\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"streetAddress\": \"45 Sunset Rd\",\n \"locality\": \"San Francisco\",\n \"postalCode\": \"12345\",\n \"country\": \"US\",\n \"region\": \"CA\"\n }\n ],\n \"displayName\": \"\",\n \"emails\": [\n {\n \"value\": \"sam.pearson@example.com\",\n \"verified\": false\n }\n ],\n \"id\": \"e27a4f96-eb00-4d6f-8d6e-983c38e25eb3\",\n \"ims\": [],\n \"locale\": \"\",\n \"name\": {\n \"familyName\": \"Pearson\",\n \"givenName\": \"Sam\"\n },\n \"nickName\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"(333) 666-7777\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"\",\n \"profileUrl\": \"\",\n \"timezone\": \"\",\n \"title\": \"\",\n \"userName\": \"SamPearson\",\n \"userType\": \"\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:53:17.387517Z\",\n \"lastModified\": \"2019-07-25T14:53:17.387677Z\"\n }\n }\n ],\n \"totalResults\": 3,\n \"itemsPerPage\": 3,\n \"pagedResultsCookie\": null\n}"}],"_postman_id":"778c4fb4-f001-4911-a4fa-246a2973c1da"},{"name":"Get users with search filter ","event":[{"listen":"test","script":{"id":"570678be-7344-4365-83fa-236eeff8b588","exec":[""],"type":"text/javascript"}}],"id":"356cda85-9cd2-4484-8820-db468641e3d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{tenantApiV1Url}}/users?{{parameter}}={{userProperty}}%20{{comparator}}%20%22{{value}}%22","description":"

Returns a paged list of end users. You can limit output based on parameters with conditions, as discussed in our documentation on Querying Users.

\n

This call provides a model, with the following options added to the endpoint:

\n\n

The example request shown in the right-hand column performs a conditional search for users, with the following options:

\n\n

The %20 and %22 in the example request URI represent a space and a double-quote, respectively, encoded in UTF-8 format.

\n

Based on the example request, you'll see user information for bjensen@example.com in the example response.

\n","urlObject":{"path":["users"],"host":["{{tenantApiV1Url}}"],"query":[{"key":"{{parameter}}","value":"{{userProperty}}%20{{comparator}}%20%22{{value}}%22"}],"variable":[]}},"response":[{"id":"ab2388f4-b297-4959-b974-04c5a8340fe7","name":"Get users with search filter ","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":{"raw":"{{tenantApiV1Url}}/users?{{parameter}}={{userProperty}}%20{{comparator}}%20%22{{value}}%22","host":["{{tenantApiV1Url}}"],"path":["users"],"query":[{"key":"{{parameter}}","value":"{{userProperty}}%20{{comparator}}%20%22{{value}}%22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1427"},{"key":"ETag","value":"W/\"593-SifopAB8m2CyRfbsCisQGZEemT0\""},{"key":"Date","value":"Thu, 25 Jul 2019 15:08:24 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n ],\n \"Resources\": [\n {\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n },\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"postalCode\": \"94703\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 94703 USA\",\n \"primary\": true\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"5962435d-6ad1-469b-8017-20141675fa3d\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n },\n {\n \"value\": \"555-555-5553\",\n \"type\": \"work\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-25T14:48:19.427048Z\",\n \"lastModified\": \"2019-07-25T14:49:43.660688Z\"\n }\n }\n ],\n \"totalResults\": 1,\n \"itemsPerPage\": 1,\n \"pagedResultsCookie\": null\n}"}],"_postman_id":"356cda85-9cd2-4484-8820-db468641e3d5"},{"name":"Request Password Reset Token","event":[{"listen":"test","script":{"id":"6dfcc441-e4db-4c56-b18e-a49c499525d6","exec":[""],"type":"text/javascript"}}],"id":"5b8a442b-44c5-43fd-9af2-2855bdedb1a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"destinationUrl\": \"http://your-password-reset.com\",\n\t\"email\": \"bjensen@example.com\",\n\t\"userName\": \"bjensen@example.com\"\n}"},"url":"{{tenantApiV1Url}}/users/reset-password","description":"

Sends the user an email containing a link to a password reset page. The password reset page is the destinationUrl parameter specified in the request payload.

\n","urlObject":{"path":["users","reset-password"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"b2502d81-2057-4ab6-935e-9ac910274bdd","name":"Request Password Reset Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"destinationUrl\": \"http://your-password-reset.com\",\n\t\"email\": \"bjensen@example.com\",\n\t\"userName\": \"bjensen@example.com\"\n}"},"url":"{{tenantApiV1Url}}/users/reset-password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"ETag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"Date","value":"Sun, 21 Jul 2019 15:00:14 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"5b8a442b-44c5-43fd-9af2-2855bdedb1a4"},{"name":"Reset Password with Token","id":"2bde76cb-577d-47a2-b879-1ab523de9feb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"Password2##\"\n\n}"},"url":"{{tenantApiV1Url}}/users/reset-password/{{resetPasswordToken}}","description":"

Using the token retreived from the link from the received email as the identifier in the endpoint.

\n

eg:\nhttp://your-password-reset.com/?token=L5mbSBVB2ctte6GNd24TPr6SJcFe6GWjC8H0S1OItkCScO5T35s8StRX2FQnhP0M

\n","urlObject":{"path":["users","reset-password","{{resetPasswordToken}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"2948460d-6b15-4f86-ae56-ba254a8b57cd","name":"Reset Password with Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"UsersResetPassw0rd!\"\n}"},"url":"{{tenantApiV1Url}}/users/reset-password/{{resetPasswordToken}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"ETag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"Date","value":"Sun, 21 Jul 2019 15:11:57 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"2bde76cb-577d-47a2-b879-1ab523de9feb"},{"name":"Recover Username","id":"db9e4c11-0574-473e-afe1-91f859801623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"bjensen@example.com\"\n}"},"url":"{{tenantApiV1Url}}/users/recover-username","description":"

Sends a message to the specifed email address containing the user's username.

\n","urlObject":{"path":["users","recover-username"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"db9e4c11-0574-473e-afe1-91f859801623"}],"id":"895f2510-9d4f-41ad-b1f3-c2cb7923e8a9","description":"

Manage and configure users in Express . Use the /me endpoint to manage the user who is logged into the current application.

\n

Each time you create a new user in Express, our test script will store the userName and user idin the postman variables userName and userId, These postman variable are used by additional calls in the Users collection and in the Authentication collections.

\n","event":[{"listen":"prerequest","script":{"id":"786c0513-243a-4061-bb5d-e5291e1aa070","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c9ffa518-2751-4e35-9aec-23ff3cf4b9df","type":"text/javascript","exec":[""]}}],"_postman_id":"895f2510-9d4f-41ad-b1f3-c2cb7923e8a9","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Me","item":[{"name":"Get Me","id":"c582e6c2-3791-4f1e-af8c-d00d80a0dd60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{tenantApiV1Url}}/me","description":"

Gets my user profile.

\n","urlObject":{"path":["me"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"70e95645-4703-4ad0-af1a-50395722a1d7","name":"Get Me","originalRequest":{"method":"GET","header":[],"url":"{{tenantApiV1Url}}/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1282"},{"key":"ETag","value":"W/\"502-czoQYomYW2KR2+4QsTCaeBF2MNE\""},{"key":"Date","value":"Sun, 21 Jul 2019 15:56:10 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"55456788-bf21-4e99-876a-ae393b294655\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-21T14:56:57.982093Z\",\n \"lastModified\": \"2019-07-21T14:56:57.982188Z\"\n }\n}"}],"_postman_id":"c582e6c2-3791-4f1e-af8c-d00d80a0dd60"},{"name":"Update Me","id":"a2df9097-969d-4dde-b189-fd2de68697eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Babs\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n }\n}"},"url":"{{tenantApiV1Url}}/me","description":"

Updates my user profile.

\n","urlObject":{"path":["me"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"ccc0ae1f-8edf-4ed2-ab9c-1af422a8b4db","name":"Update Me","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Babs\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n }\n}"},"url":"{{tenantApiV1Url}}/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1279"},{"key":"ETag","value":"W/\"4ff-ZrHGbd+26y4SRbLdeLdyYv+Hdl4\""},{"key":"Date","value":"Sun, 21 Jul 2019 16:11:28 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"55456788-bf21-4e99-876a-ae393b294655\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Babs\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-21T14:56:57.982093Z\",\n \"lastModified\": \"2019-07-21T16:11:28.842513Z\"\n }\n}"}],"_postman_id":"a2df9097-969d-4dde-b189-fd2de68697eb"},{"name":"Update Password","id":"eb837039-8a29-4752-8026-ebbc2b131fe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"newPassword\": \"Password#1\",\n\t\"oldPassword\": \"{{userPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/me/update-password","description":"

Updates my password.

\n","urlObject":{"path":["me","update-password"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"a3542204-0729-479d-86d7-e8aca44f03c4","name":"Update Password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"newPassword\": \"Password#1\",\n\t\"oldPassword\": \"{{userPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/me/update-password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1282"},{"key":"ETag","value":"W/\"502-P1J1jUDBHHEKwTzaTTspkFayZLs\""},{"key":"Date","value":"Sun, 21 Jul 2019 16:29:25 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"accountStatus\": \"Active\",\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"6925 Hollywood Blvd\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"90028\",\n \"country\": \"US\",\n \"formatted\": \"6925 Hollywood Blvd\\nHollywood, CA 90028 USA\",\n \"primary\": true\n },\n {\n \"type\": \"home\",\n \"streetAddress\": \"2800 E Observatory Rd\",\n \"locality\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postalCode\": \"90027\",\n \"country\": \"US\",\n \"formatted\": \"2800 E Observatory Rd\\nLos Angeles, CA 90027 USA\"\n }\n ],\n \"displayName\": \"Babs Jensen\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"type\": \"work\",\n \"primary\": true,\n \"verified\": false\n },\n {\n \"value\": \"babs@jensen.org\",\n \"type\": \"home\",\n \"verified\": false\n }\n ],\n \"id\": \"502f783e-9be4-488a-a3a8-cb4b163f45aa\",\n \"ims\": [],\n \"locale\": \"en-US\",\n \"name\": {\n \"formatted\": \"Ms. Barbara J Jensen, III\",\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\",\n \"middleName\": \"Jane\",\n \"honorificPrefix\": \"Ms.\",\n \"honorificSuffix\": \"III\"\n },\n \"nickName\": \"Babs\",\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"preferences\": {},\n \"preferredLanguage\": \"en-US\",\n \"profileUrl\": \"https://login.example.com/bjensen\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Master Carpenter\",\n \"userName\": \"bjensen@example.com\",\n \"userType\": \"Customer\",\n \"x509Certificates\": [],\n \"meta\": {\n \"created\": \"2019-07-21T16:19:09.070672Z\",\n \"lastModified\": \"2019-07-21T16:29:25.476664Z\"\n }\n}"}],"_postman_id":"eb837039-8a29-4752-8026-ebbc2b131fe0"}],"id":"9700bc18-66c1-4ecc-8aec-f7b4ace53823","description":"

The Me endpoint are for the user to perform operations on their own profile. Prior to using them, you need to obtain an access token of the user which you can get by calling our authentication APIs.

\n","event":[{"listen":"prerequest","script":{"id":"39a24b4d-1a30-4429-87cb-2578f99a74dd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7615042f-4b37-4f51-aaaf-aa26f5439280","type":"text/javascript","exec":[""]}}],"_postman_id":"9700bc18-66c1-4ecc-8aec-f7b4ace53823","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Password Policies","item":[{"name":"Get Password Policy","id":"1e86d86b-42a4-48c1-a425-77d0d1f22797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{tenantApiV1Url}}/password-policy","description":"

Retreives the current password policy.

\n

For a discussion of the output, see our documentation on Password Policies.

\n","urlObject":{"path":["password-policy"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"70486abc-1e12-4c84-bb79-1f3614321584","name":"Get Password Policy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{tenantApiV1Url}}/password-policy?=","host":["{{tenantApiV1Url}}"],"path":["password-policy"],"query":[{"key":"","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"291"},{"key":"ETag","value":"W/\"123-iby68TsmtMhkBbUChRgtiMKd5cc\""},{"key":"Date","value":"Fri, 29 Mar 2019 15:46:41 GMT"},{"key":"Via","value":"1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"disallowFirstNamePart\": true,\n \"disallowLastNamePart\": true,\n \"lockoutPasswordAttempts\": 0,\n \"maxPasswordAge\": 0,\n \"minPasswordLength\": 8,\n \"requireEmailVerification\": false,\n \"requireLowerCaseLetter\": true,\n \"requireNumber\": true,\n \"requireSymbol\": true,\n \"requireUpperCaseLetter\": true,\n \"selfServeUnlockDuration\": 15\n}"}],"_postman_id":"1e86d86b-42a4-48c1-a425-77d0d1f22797"},{"name":"Set Password Policy","id":"3ab4c229-5932-42e7-99ef-ccb88709a367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"disallowFirstNamePart\": true,\n \"disallowLastNamePart\": true,\n \"lockoutPasswordAttempts\": 0,\n \"maxPasswordAge\": 0,\n \"minPasswordLength\": 8,\n \"requireEmailVerification\": false,\n \"requireLowerCaseLetter\": true,\n \"requireNumber\": true,\n \"requireSymbol\": true,\n \"requireUpperCaseLetter\": true,\n \"selfServeUnlockDuration\": 1\n}"},"url":"{{tenantApiV1Url}}/password-policy","description":"

Sets the password policy. Returns the configured password policy upon success.

\n

When configuring this REST call, include all options shown from the GET Password Policy call.

\n

For details on each option, see our documentation on Password Policies.

\n","urlObject":{"path":["password-policy"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"02f0e39b-9ff4-4946-bac3-17b75487a162","name":"Set Password Policy","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"disallowFirstNamePart\": true,\n \"disallowLastNamePart\": true,\n \"lockoutPasswordAttempts\": 0,\n \"maxPasswordAge\": 0,\n \"minPasswordLength\": 8,\n \"requireEmailVerification\": false,\n \"requireLowerCaseLetter\": true,\n \"requireNumber\": true,\n \"requireSymbol\": true,\n \"requireUpperCaseLetter\": true,\n \"selfServeUnlockDuration\": 1\n}"},"url":"{{tenantApiV1Url}}/password-policy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"290"},{"key":"ETag","value":"W/\"122-40KN1f/1xWyfpuG4JMen6GSFopg\""},{"key":"Date","value":"Fri, 01 Mar 2019 19:56:08 GMT"},{"key":"Via","value":"1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"disallowFirstNamePart\": true,\n \"disallowLastNamePart\": true,\n \"lockoutPasswordAttempts\": 0,\n \"maxPasswordAge\": 0,\n \"minPasswordLength\": 8,\n \"requireEmailVerification\": false,\n \"requireLowerCaseLetter\": true,\n \"requireNumber\": true,\n \"requireSymbol\": true,\n \"requireUpperCaseLetter\": true,\n \"selfServeUnlockDuration\": 1\n}"}],"_postman_id":"3ab4c229-5932-42e7-99ef-ccb88709a367"}],"id":"e1fd1cf4-c502-48ed-bf6c-8113ac96ea21","description":"

Manage the global password policy for users of the tenant. Use the GET Password Policy call to review the current password policy, in JSON format. You can then use the output to format your desired password policy, through the Set Password Policy call.

\n\n

For a more complete discussion, see our documentation on Password Policies.

\n","event":[{"listen":"prerequest","script":{"id":"ada8cd49-54e4-4cb8-bfcb-8734cf0dce62","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"af7f3d28-e84d-45a7-a007-37dcd52ef276","type":"text/javascript","exec":[""]}}],"_postman_id":"e1fd1cf4-c502-48ed-bf6c-8113ac96ea21","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Email Templates","item":[{"name":"Get Email Templates","id":"b751490a-87bf-4d50-bc4b-8e9f5e481a97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{accessToken}}","description":"

Requires the access_token for the hosting environment.

\n"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{tenantApiV1Url}}/email-templates","description":"

Gets a list of available email templates. You'll see output:

\n\n

For more information, see our documentation on Email Templates.

\n

To send a test email via REST, review the output for the desired template type or id. Include that information in the POST Send Test Email REST call.

\n","urlObject":{"path":["email-templates"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"5cf648aa-353d-4247-b871-f51b2b3a2305","name":"Get Email Templates","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{accessToken}}","description":"Requires the `access_token` for the hosting environment."},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{tenantApiV1Url}}/email-templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"14373"},{"key":"ETag","value":"W/\"3825-igGwgDUBUNUvg63TJIoaccHRPxw\""},{"key":"Date","value":"Fri, 18 Oct 2019 20:16:02 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAr8iACg\",\n \"body\": \"\\n# Verify your Account\\n\\nThanks for signing up for {{organization.name}}. Verify your account by\\nclicking on the link below.\\n\\n[Verify my account]({{{url}}})\\n\\nThis link will expire in {{urlExpiry}}.\\n\\nThanks!\\n\\n{{organization.name}}\\n\\nIf you did not make this request, please contact us\\n\",\n \"bodyRendered\": \"

Verify your Account

\\n\\n

Thanks for signing up for {{organization.name}}. Verify your account by\\nclicking on the link below.

\\n\\n

Verify my account

\\n\\n

This link will expire in {{urlExpiry}}.

\\n\\n

Thanks!

\\n\\n

{{organization.name}}

\\n\\n

If you did not make this request, please contact us

\\n
\",\n \"description\": \"Sent once after the user registers their account\",\n \"enabled\": true,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Registration\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Verify your {{{organization.name}}} account\",\n \"type\": \"registration\",\n \"urlLifetime\": 2880\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgIDA9tiBCg\",\n \"body\": \"\\n# Welcome\\n\\nIf you have any questions or issues with your account please contact us.\\n\\nThanks!\\n\\n{{organization.name}}\\n\\nIf you did not make this request, please contact us.\\n\",\n \"bodyRendered\": \"

Welcome

\\n\\n

If you have any questions or issues with your account please contact us.

\\n\\n

Thanks!

\\n\\n

{{organization.name}}

\\n\\n

If you did not make this request, please contact us.

\\n
\",\n \"description\": \"Confirms the user has verified their email address or registered the app\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Welcome\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Welcome to {{{organization.name}}}\",\n \"type\": \"welcome\",\n \"urlLifetime\": 0\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAgOSRCg\",\n \"body\": \"\\nHi {{user.name.givenName}},\\n\\nSomeone recently requested a password change for your\\n{{organization.name}} account. If this was you, you can set a new\\npassword here:\\n\\n[Reset password]({{{url}}})\\n\\nThis link will expire in {{urlExpiry}}.\\n\\nIf you don't want to change your password or didn't request this, just\\nignore and delete this message.\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Hi {{user.name.givenName}},

\\n\\n

Someone recently requested a password change for your\\n{{organization.name}} account. If this was you, you can set a new\\npassword here:

\\n\\n

Reset password

\\n\\n

This link will expire in {{urlExpiry}}.

\\n\\n

If you don’t want to change your password or didn’t request this, just\\nignore and delete this message.

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Provides a link to let users change their password\",\n \"enabled\": true,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Forgotten Password\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Reset your {{{organization.name}}} password\",\n \"type\": \"forgot-password\",\n \"urlLifetime\": 2880\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAvNWTCg\",\n \"body\": \"\\nHi {{user.name.givenName}},\\n\\nThe password for your {{organization.name}} account was recently changed.\\n\\nIf you did not make this request, please contact us.\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Hi {{user.name.givenName}},

\\n\\n

The password for your {{organization.name}} account was recently changed.

\\n\\n

If you did not make this request, please contact us.

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Confirms that the user's password was updated\",\n \"enabled\": true,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Password Updated\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"You have successfully reset your {{{organization.name}}} password\",\n \"type\": \"reset-password\",\n \"urlLifetime\": 0\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAvKGCCg\",\n \"body\": \"\\nHi {{user.name.givenName}},\\n\\nThe email for your {{organization.name}} email was recently changed to a\\nnew address. This notification has been sent to both old and new\\naddresses.\\n\\nIf you did not make this request, please contact us.\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Hi {{user.name.givenName}},

\\n\\n

The email for your {{organization.name}} email was recently changed to a\\nnew address. This notification has been sent to both old and new\\naddresses.

\\n\\n

If you did not make this request, please contact us.

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Confirms the user's email address has been updated\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Updated Email Address\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"You have updated your {{{organization.name}}} email\",\n \"type\": \"email-update-successful\",\n \"urlLifetime\": 0\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICA7bGDCg\",\n \"body\": \"\\nHi {{user.name.givenName}},\\n\\nYou have received this email because you have forgotten your\\n{{organization.name}} username.\\n\\nYour username is {{user.userName}}\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Hi {{user.name.givenName}},

\\n\\n

You have received this email because you have forgotten your\\n{{organization.name}} username.

\\n\\n

Your username is {{user.userName}}

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Confirms recovered username\",\n \"enabled\": true,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Username Recovery\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Your username for {{{organization.name}}}\",\n \"type\": \"recover-username\",\n \"urlLifetime\": 2880\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgIDAjOmCCg\",\n \"body\": \"\\nYour username, {{user.userName}}, was retrieved.\\n\\nIf you did not recently look up your username, or you need help accessing\\nyour account, please contact us.\\n\\nFor your security, keep your username and password \\nconfidential—they’re the keys to accessing your account.\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Your username, {{user.userName}}, was retrieved.

\\n\\n

If you did not recently look up your username, or you need help accessing\\nyour account, please contact us.

\\n\\n

For your security, keep your username and password\\nconfidential—they’re the keys to accessing your account.

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Confirms that the user requested a recovery email\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Username Recovery Confirmation\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Your username for {{{organization.name}}} was recovered\",\n \"type\": \"username-recovered\",\n \"urlLifetime\": 0\n },\n {\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICA3pCBCg\",\n \"body\": \"\\nHi {{user.name.givenName}},\\n\\nThe verification code you requested is: {{params.otp}}\\n\\nThanks,\\n\\n{{organization.name}}\\n\",\n \"bodyRendered\": \"

Hi {{user.name.givenName}},

\\n\\n

The verification code you requested is: {{params.otp}}

\\n\\n

Thanks,

\\n\\n

{{organization.name}}

\\n
\",\n \"description\": \"Sent to users who request an emailed verification code in a multi-factor authentication tree\",\n \"enabled\": true,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@{{tenant.name}}.com\",\n \"name\": \"Verification Code\",\n \"styles\": \"#body {\\n font-family:'Roboto',sans;\\n text-align:center;\\n}\\n\\na {\\n background-color:#2d9ee0;\\n border-radius:4px;\\n color:#fff;\\n display:inline-block;\\n font-size:14px;\\n font-weight:500;\\n letter-spacing:1px;\\n margin:20px;\\n padding:16px;\\n text-transform:uppercase;\\n text-decoration:none;\\n}\\n\\na:hover {\\n background-color:#2192d4;\\n text-decoration:none !important;\\n}\\n\\nh1 {\\n color:#455369;\\n font-weight:300;\\n}\\n\",\n \"subject\": \"Your verification code for {{organization.name}}\",\n \"type\": \"one-time-passcode\",\n \"urlLifetime\": 0\n }\n]"}],"_postman_id":"b751490a-87bf-4d50-bc4b-8e9f5e481a97"},{"name":"Modify Email Templates","id":"fa286b18-3348-4ebe-b508-52fe06554636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{accessToken}}","description":"

Requires the access_token for the hosting environment.

\n"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAr8iACg\",\n \"body\": \"\\n# Welcome Modified \\n\\nIf you have any questions or issues with your account please contact us.\\n\\nThanks!\\n\\n{{organization.name}}\\n\\nIf you did not make this request, please contact us.\",\n \"bodyRendered\": \"

Welcome

\\n

If you have any questions or issues with your account please contact us.

\\n

Thanks!

\\n

{{organization.name}}

\\n

If you did not make this request, please contact us.

\\n
\",\n \"description\": \"Confirms the user has verified their email address or registered the app\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@sample-org.com\",\n \"name\": \"Welcome\",\n \"styles\": \"#body{font-family:'Roboto',sans;text-align:center}a{color:#004b9b;text-decoration:none}a:hover{text-decoration:underline}h1{color:#455369;font-weight:300}.btn{background-color:#2d9ee0;border-radius:4px;color:#fff;display:inline-block;font-size:14px;font-weight:500;letter-spacing:1px;margin:20px;padding:16px;text-transform:uppercase;text-decoration:none}.btn:hover{background-color:#2192d4;text-decoration:none !important}\",\n \"subject\": \"Welcome to {{{organization.name}}}\",\n \"type\": \"welcome\",\n \"urlLifetime\": 0\n}"},"url":"{{tenantApiV1Url}}/email-templates/{{emailTemplateId}}","description":"

Modifies the specified email template

\n","urlObject":{"path":["email-templates","{{emailTemplateId}}"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"05a49c7e-3aac-4556-bb2f-ad78a0a36d1f","name":"Modify Email Template","originalRequest":{"method":"PUT","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{accessToken}}","description":"Requires the `access_token` for the hosting environment."},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAr8iACg\",\n \"body\": \"\\n# Welcome Modified \\n\\nIf you have any questions or issues with your account please contact us.\\n\\nThanks!\\n\\n{{organization.name}}\\n\\nIf you did not make this request, please contact us.\",\n \"bodyRendered\": \"

Welcome

\\n

If you have any questions or issues with your account please contact us.

\\n

Thanks!

\\n

{{organization.name}}

\\n

If you did not make this request, please contact us.

\\n
\",\n \"description\": \"Confirms the user has verified their email address or registered the app\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@sample-org.com\",\n \"name\": \"Welcome\",\n \"styles\": \"#body{font-family:'Roboto',sans;text-align:center}a{color:#004b9b;text-decoration:none}a:hover{text-decoration:underline}h1{color:#455369;font-weight:300}.btn{background-color:#2d9ee0;border-radius:4px;color:#fff;display:inline-block;font-size:14px;font-weight:500;letter-spacing:1px;margin:20px;padding:16px;text-transform:uppercase;text-decoration:none}.btn:hover{background-color:#2192d4;text-decoration:none !important}\",\n \"subject\": \"Welcome to {{{organization.name}}}\",\n \"type\": \"welcome\",\n \"urlLifetime\": 0\n}"},"url":"{{tenantApiV1Url}}/email-templates/{{emailTemplateId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1426"},{"key":"ETag","value":"W/\"592-nRbYA14DYfHgE8mlBnx8z0lcXjc\""},{"key":"Date","value":"Wed, 31 Jul 2019 15:27:48 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ChEiD3JvYm90LW5hbWVzcGFjZRIZCg5FbWFpbFRlbXBsYXRlcxCAgICAr8iACg\",\n \"body\": \"\\n# Welcome Modified \\n\\nIf you have any questions or issues with your account please contact us.\\n\\nThanks!\\n\\n{{organization.name}}\\n\\nIf you did not make this request, please contact us.\",\n \"bodyRendered\": \"

Welcome Modified

\\n

If you have any questions or issues with your account please contact us.

\\n

Thanks!

\\n

{{organization.name}}

\\n

If you did not make this request, please contact us.

\\n
\",\n \"description\": \"Confirms the user has verified their email address or registered the app\",\n \"enabled\": false,\n \"from\": \"{{{organization.name}}}\",\n \"fromAddress\": \"noreply@sample-org.com\",\n \"name\": \"Welcome\",\n \"styles\": \"#body{font-family:'Roboto',sans;text-align:center}a{color:#004b9b;text-decoration:none}a:hover{text-decoration:underline}h1{color:#455369;font-weight:300}.btn{background-color:#2d9ee0;border-radius:4px;color:#fff;display:inline-block;font-size:14px;font-weight:500;letter-spacing:1px;margin:20px;padding:16px;text-transform:uppercase;text-decoration:none}.btn:hover{background-color:#2192d4;text-decoration:none !important}\",\n \"subject\": \"Welcome to {{{organization.name}}}\",\n \"type\": \"welcome\",\n \"urlLifetime\": 0\n}"}],"_postman_id":"fa286b18-3348-4ebe-b508-52fe06554636"},{"name":"Send Test Email through SMTP","id":"233e8b96-bbd1-436a-9e07-136fc4ab27f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"templateId\":\"{{templateId}}\",\n \"userId\": \"{{userId}}\"\n}"},"url":"{{tenantApiV1Url}}/email","description":"

llows you to send a test email through one of the following SMTP servers:

\n\n

You'll need the following parameters in the request data:

\n\n","urlObject":{"path":["email"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"a6638547-5cad-4a09-b689-2d9e3d081b7e","name":"Configure/Modify SMTP Server","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"host\":\"{{smtpHost}}\",\n \"mandatoryTLS\": true,\n \"port\": {{smtpPort}},\n \"username\": \"{{smtpUsername}}\",\n \"password\": \"{{smtpPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/email-server"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"},{"key":"ETag","value":"W/\"62-FvfdGRiaLjf6dA5FeC4OmKruY3U\""},{"key":"Date","value":"Mon, 09 Sep 2019 22:35:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"mandatoryTLS\": true,\n \"port\": 587,\n \"username\": \"\"\n}"}],"_postman_id":"233e8b96-bbd1-436a-9e07-136fc4ab27f3"}],"id":"a008a9d7-d2f4-45d8-b689-62d279328525","description":"

Use these REST calls to:

\n
    \n
  • Review available email templates.
    • \n
  • Send a test email.
    • \n
\n

Endpoints:

\n
    \n
  • /email-templates
    • \n
  • /email
    • \n
\n","event":[{"listen":"prerequest","script":{"id":"f35a7fbf-32d1-4209-81fa-8cd45677f194","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c8a5d82f-68df-4ef7-9885-ed8bdaf10bce","type":"text/javascript","exec":[""]}}],"_postman_id":"a008a9d7-d2f4-45d8-b689-62d279328525","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Outgoing Email Server (SMTP)","item":[{"name":"Get SMTP Configuration","id":"d341a48f-f7e4-4542-bfec-b8f5ba3a688c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"description":"

Requires the access_token for the hosting environment.

\n","key":"Authorization","value":"Bearer {{accessToken}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{tenantApiV1Url}}/email-server","description":"

Returns details for the currently configured outgoing email server, including:

\n
    \n
  • host: Hostname or IP address
    • \n
  • mandatoryTLS: Whether TLS is required for the server (true/false)
    • \n
  • port: Port number
    • \n
  • username: User for authenticating on the SMTP server
    • \n
\n

If no SMTP server has been configured, you'll see a \"404 Not Found\" message in the output.

\n","urlObject":{"path":["email-server"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"42e79be0-e039-4b1e-a8f2-668a6536fd10","name":"Get SMTP Configuration","originalRequest":{"method":"GET","header":[{"description":"Requires the `access_token` for the hosting environment.","key":"Authorization","value":"Bearer {{accessToken}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{tenantApiV1Url}}/email-server"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"},{"key":"ETag","value":"W/\"62-FvfdGRiaLjf6dA5FeC4OmKruY3U\""},{"key":"Date","value":"Mon, 09 Sep 2019 22:36:23 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"mandatoryTLS\": true,\n \"port\": ,\n \"username\": \"\"\n}"}],"_postman_id":"d341a48f-f7e4-4542-bfec-b8f5ba3a688c"},{"name":"Configure/Modify SMTP Server","id":"67b4de4d-1785-4c14-967d-fc43bc8f1138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"host\":\"{{smtpHost}}\",\n \"mandatoryTLS\": true,\n \"port\": {{smtpPort}},\n \"username\": \"{{smtpUsername}}\",\n \"password\": \"{{smtpPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/email-server","description":"

Allows you to set up or modify an SMTP server. You can include the following parameters in the request data:

\n
    \n
  • host: Hostname or IP address
    • \n
  • mandatoryTLS: Whether TLS is required for the server (true/false)
    • \n
  • port: Port number
    • \n
  • username: User for authenticating on the SMTP server
    • \n
  • password: Password for the noted user
    • \n
\n","urlObject":{"path":["email-server"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"4795cb45-ba04-4cc1-b58a-2f7706093cdd","name":"Configure/Modify SMTP Server","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"host\":\"{{smtpHost}}\",\n \"mandatoryTLS\": true,\n \"port\": {{smtpPort}},\n \"username\": \"{{smtpUsername}}\",\n \"password\": \"{{smtpPassword}}\"\n}"},"url":"{{tenantApiV1Url}}/email-server"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"98"},{"key":"ETag","value":"W/\"62-FvfdGRiaLjf6dA5FeC4OmKruY3U\""},{"key":"Date","value":"Mon, 09 Sep 2019 22:35:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"mandatoryTLS\": true,\n \"port\": 587,\n \"username\": \"\"\n}"}],"_postman_id":"67b4de4d-1785-4c14-967d-fc43bc8f1138"},{"name":"Delete Configured SMTP Server","id":"a0680f00-e082-4e7f-b049-d725b17b21eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{accessToken}}"}],"body":{"mode":"raw","raw":""},"url":"{{tenantApiV1Url}}/email-server","description":"

Deletes any configured SMTP server. If successful, you'll see no output and a \"204 No Content\" message.

\n","urlObject":{"path":["email-server"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0680f00-e082-4e7f-b049-d725b17b21eb"}],"id":"98591594-f31c-4ec8-94ca-1c6657ce954e","description":"

Use these REST calls to:

\n
    \n
  • Configure/modify an SMTP server
    • \n
  • Get the current configuration
    • \n
\n

Endpoint:

\n
    \n
  • /email-server
    • \n
\n

Prerequisite:

\n

Activate the following API Scopes for each of your relevant apps.

\n
    \n
  • email-server-config.read
    • \n
  • email-server-config.update
    • \n
  • email-server-config.delete
    • \n
\n

For more information, see our documentation on SMTP Email Services.

\n","event":[{"listen":"prerequest","script":{"id":"f35a7fbf-32d1-4209-81fa-8cd45677f194","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c8a5d82f-68df-4ef7-9885-ed8bdaf10bce","type":"text/javascript","exec":[""]}}],"_postman_id":"98591594-f31c-4ec8-94ca-1c6657ce954e","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Hosted Pages","item":[{"name":"Get Hosted Page","id":"d2c33654-17ca-4af7-84e0-d88e1e68fb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"description":"

Requires the access_token for the hosting environment.

\n","key":"Authorization","type":"text","value":"Bearer {{accessToken}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"formdata","formdata":[]},"url":"{{tenantApiV1Url}}/hosted-pages","description":"

Returns the current hosted page configuration.

\n

To modify the settings for your hosted page, use the output here as input in the body of the PUT Modify Existing Hosted Page REST call.

\n

Requires the access_token for the hosting environment.

\n","urlObject":{"path":["hosted-pages"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"c228fdee-0209-4e9e-a148-b44e90fe4ba1","name":"Get Hosted Page","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"description":"Requires the `access_token` for the hosting environment.","key":"Authorization","type":"text","value":"Bearer {{accessToken}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{tenantApiV1Url}}/hosted-pages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"297"},{"key":"ETag","value":"W/\"129-iy63LKrlYgMYUVeBQmAA/hsrWJs\""},{"key":"Date","value":"Thu, 05 Sep 2019 21:01:00 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"cssUrl\": \"https://ui-docs98.forgeblocks.com/css/hosted.css\",\n \"forgotPasswordTitle\": \"Reset Password\",\n \"logoUrl\": \"https://ui-docs98.forgeblocks.com/img/logo-forgerock.png\",\n \"recoverUsernameTitle\": \"Recover Username\",\n \"resetPasswordTitle\": \"Reset Password\",\n \"signInTitle\": \"Sign In\",\n \"signUpTitle\": \"Sign Up\"\n}"}],"_postman_id":"d2c33654-17ca-4af7-84e0-d88e1e68fb78"},{"name":"Modify Existing Hosted Page","id":"a4d56698-79f6-4ee2-b23f-79c22c2eff18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cssUrl\": \"https://ui-{{tenantName}}.forgeblocks.com/css/hosted.css\",\n \"forgotPasswordTitle\": \"Reset Your Password\",\n \"logoUrl\": \"https://ui-{{tenantName}}.forgeblocks.com/img/logo-forgerock.png\",\n \"recoverUsernameTitle\": \"Recover Your Username\",\n \"resetPasswordTitle\": \"Reset Password\",\n \"signInTitle\": \"Sign In\",\n \"signUpTitle\": \"Sign Up\"\n}"},"url":"{{tenantApiV1Url}}/hosted-pages","description":"

Take the output of the GET Hosted Page REST call. Modify as desired, and use it as data (-d) input to this REST call.

\n

Requires the access_token for the hosting environment.

\n

All properties are required to avoid an error message.

\n","urlObject":{"path":["hosted-pages"],"host":["{{tenantApiV1Url}}"],"query":[],"variable":[]}},"response":[{"id":"4f650817-0d35-4d0c-93bf-c0b0b11ab761","name":"Modify Existing Hosted Page","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cssUrl\": \"https://ui-{{tenantName}}.forgeblocks.com/css/hosted.css\",\n \"forgotPasswordTitle\": \"Reset Your Password\",\n \"logoUrl\": \"https://ui-{{tenantName}}.forgeblocks.com/img/logo-forgerock.png\",\n \"recoverUsernameTitle\": \"Recover Your Username\",\n \"resetPasswordTitle\": \"Reset Password\",\n \"signInTitle\": \"Sign In\",\n \"signUpTitle\": \"Sign Up\"\n}"},"url":"{{tenantApiV1Url}}/hosted-pages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"313"},{"key":"ETag","value":"W/\"139-IPSZkehxsqHL6DLdG1BmWErBWFQ\""},{"key":"Date","value":"Fri, 26 Jul 2019 16:25:29 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"cssUrl\": \"https://ui-sampletenant.forgeblocks.com/css/hosted.css\",\n \"forgotPasswordTitle\": \"Reset Your Password\",\n \"logoUrl\": \"https://ui-sampletenant.forgeblocks.com/img/logo-forgerock.png\",\n \"recoverUsernameTitle\": \"Recover Your Username\",\n \"resetPasswordTitle\": \"Reset Password\",\n \"signInTitle\": \"Sign In\",\n \"signUpTitle\": \"Sign Up\"\n}"}],"_postman_id":"a4d56698-79f6-4ee2-b23f-79c22c2eff18"}],"id":"791cceaf-f0b2-4976-830d-72a3b6e9e9e4","description":"

The /hosted-pages endpoint allows you to list and add/modify pages to host on your app.

\n","event":[{"listen":"prerequest","script":{"id":"af2ca384-ea60-496a-b536-a9f1a953d465","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7c3f62a-84a7-4634-9d31-9fa292b1a0fe","type":"text/javascript","exec":[""]}}],"_postman_id":"791cceaf-f0b2-4976-830d-72a3b6e9e9e4","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}}],"id":"82402642-f30e-45a1-8cbf-58d4efd4fcbd","description":"

The Management API allows you to manage objects (including users).With your apps, you can exchange a client ID and secret for an access token and call the API using the token.

\n

Some of these apps require the access_token for your ui-{{tenantName}}.forgeblocks.com app. You can get this token from the developer console for your browser, as the Authorization: Bearer token under Request Headers.

\n","event":[{"listen":"prerequest","script":{"id":"8b111599-f57a-4b75-8685-259b866b4e8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0cd4abd4-3da3-447f-bccb-649d0aae4408","type":"text/javascript","exec":[""]}}],"_postman_id":"82402642-f30e-45a1-8cbf-58d4efd4fcbd","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Authentication APIs","item":[{"name":"Authentication","item":[{"name":"UserName Password Authentication","item":[{"name":"Authenticate UserName Password Step 1","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"c73e220f-5259-41b4-8ba3-be2b0118d256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"}],"body":{"mode":"raw","raw":""},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=UsernamePassword","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"UsernamePassword"}],"variable":[]}},"response":[{"id":"389ea215-e7f6-477b-8f86-77e61ef658b8","name":"Authenticate UserName Password Step 1","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=UsernamePassword","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"UsernamePassword"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2150"},{"key":"Date","value":"Wed, 31 Jul 2019 20:51:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"authId\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoSW5kZXhWYWx1ZSI6IlVzZXJuYW1lUGFzc3dvcmQiLCJvdGsiOiJscDZuY3R1dWFqM2Y2MDZzc3ZsbnBuNzZldiIsImF1dGhJbmRleFR5cGUiOiJzZXJ2aWNlIiwicmVhbG0iOiIvIiwic2Vzc2lvbklkIjoiKkFBSlRTUUFDTURJQUJIUjVjR1VBQ0VwWFZGOUJWVlJJQUFKVE1RQUNNREUuKmV5SjBlWEFpT2lKS1YxUWlMQ0pqZEhraU9pSktWMVFpTENKaGJHY2lPaUpJVXpJMU5pSjkuWlhsS01HVllRV2xQYVVwTFZqRlJhVXhEU2paaFdFRnBUMmxLVDFRd05VWkphWGRwV2xjMWFrbHFiMmxSVkVWNVQwVk9RMUY1TVVsVmVra3hUbWxKYzBsdFJuTmFlVWsyU1cxU2NHTnBTamt1TG1WM2VtUTFWWEZvYzJSclkzYzJPSHBHWlROSFZHY3VPV3BDU2tkV2VGOHhObEpTVUVGb1NFUjVOalJSUVMwd1FuVndXVXRXY2xCdFdsbzVSakF4YkVsNVprYzNTemhaVHpWcGIyWlFjMmxDVkcxc2IzSnpNRjlEYWs5UWNGRllMWGh1ZWtWbk1UaFFYelptZVdGek1IQm5kblpRTmsxNWRtZFJhSFpWVVhSYU5ucEVNRXg0WTI5d1dERlJSSE5tVUVOVGNGcEhlRkZLTkVsVWNEUXRORlV6VUdaaWNEbHVjMVpyTWpWMmVFcGFOMEpJUnkxSVlVdEZkblJvTUdWQlJtNXdUamh2ZG1OTmFtUjVhbmhQTldWblNGUlhUV1IwYlZsWFNUaGhObUZ0UTNkQlNqRk9aQzFCZFhKRmRuZHJZbVZ1VWtwR1JVOW5TV2xQTkRoVlVtOXpPRmhGZVY5elgwMXZXVEV3V2xRMGIyeE1TMjlrYmpBdFpraHdTMEZsZUROd1ZUbG9kWGRxTFZCUU9FdG1VbWwwVEdadVpWVlpTREpDTjNKblNsWkRZa3g1TUZKalpESkNXVGhYVFZOSWEyVkdTVFJJT1ZnMmRVbzFja3BaUjFWb1l6azVTbTA1T1ZCM01IUTFOVEpHZUVKUVJFSk9TVVEzWjJGMVowbFJRVGN5VTNGdk1WOXhVRlZXVWxaMldWcFFNbUZZWmxsWVMyMWtVWFozYVc5T1pXOWtiMXBTU25aRFoxUXRVRzh6VXpCVE5sbEpOVWhHTVdGaWExRm1jM1pDVGxWaVV6WmlZa2RMVW1oNFNXNVFiMGRvT1hKVlpGYzJlbXMxWmxWVU1sZGZXVjlRYUZCSlRUWnhNalZyYmpoa2JHbFpjVWswYkVadVkwd3dkbXc0VDJaTlNYVlJOREZrZDFaaU5rb3lUMVZIZFhkdlEwcFRhemRwVlhob1VqTlFUa1p2YTNKUVQzZGZhRTkxY3pSeVgybzJVMjlUVUhnNVJYSkphVkpGVVVJNGFIUnZaSFUxYjJsT00xRXpPV3BsZDBFMFptTnNiRFJtUWpKeU9HUnVNekppVFdWeVJVeHBWMEZNVjNSMWQzbzRTVXBqY1dwZmREUTRUelJGTTBaeFpuSnFVa0pOVG1kNVluTnBhQzF0WXkxbk9FVnJjaTVrZEZCMlZqVk5OaTFuVmtoVFFpMTVOVkZ0YjE5Qi5aUDNsMUhOek5pZGRnMHpqazNNWktkNFZtdmp4Y1FQcHZKemhNbHN2X0lzIiwiZXhwIjoxNTY0NjA2NTY2LCJpYXQiOjE1NjQ2MDYyNjZ9.hg7_tleZsLSJsCP4pTB0o8cCgYzHnUnAm4HddZborqk\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"}],"_postman_id":"c73e220f-5259-41b4-8ba3-be2b0118d256"},{"name":"Authenticate UserName Password Step 2","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"9007baa8-a098-4da4-a82c-7d3be7e19855","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{userName}}\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"{{userPassword}}\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=UsernamePassword","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"UsernamePassword"}],"variable":[]}},"response":[{"id":"e6d910bd-4e2d-4b95-90f3-ed90f9c8d5c1","name":"Authenticate UserName Password Step 2","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{userName}}\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"{{userPassword}}\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=UsernamePassword","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"UsernamePassword"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Set-Cookie","value":"iPlanetDirectoryPro=bxv6PG8v6P42o3Rnfs0d-NqCwEo.*AAJTSQACMDIAAlNLABxjWWJJQ3R3SjhIYTlkUWcyNzVmNHBJL05oaW89AAR0eXBlAANDVFMAAlMxAAIwMQ..*; Path=/"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"164"},{"key":"Date","value":"Wed, 31 Jul 2019 20:51:18 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"tokenId\": \"bxv6PG8v6P42o3Rnfs0d-NqCwEo.*AAJTSQACMDIAAlNLABxjWWJJQ3R3SjhIYTlkUWcyNzVmNHBJL05oaW89AAR0eXBlAANDVFMAAlMxAAIwMQ..*\",\n \"successUrl\": \"/console\",\n \"realm\": \"/\"\n}"}],"_postman_id":"9007baa8-a098-4da4-a82c-7d3be7e19855"}],"id":"665660f4-b5e1-417a-8532-b310997f4596","description":"

The API calls for the UsernamePassword Authentication flow follow the same path our JavaScript SDK for UsernamePassword do to authenticate a user. A successful outcome returns a users session token. Our postman collection stores this in a postman environment variable called sessionToken which are used to get an access_token and IdToken for the authenticated user.

\n","event":[{"listen":"prerequest","script":{"id":"57fb45bd-3d8b-44d1-beb6-f4a2cce1a9f7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a7061a2-f26f-4e1b-a8cf-a6a7f8c9d61b","type":"text/javascript","exec":[""]}}],"_postman_id":"665660f4-b5e1-417a-8532-b310997f4596","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Second Factor Authentication","item":[{"name":"First Factor UserName Password Step 1","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"3271a2f8-ad00-42ea-b9cf-bce32d8238ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"}],"body":{"mode":"raw","raw":""},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}],"variable":[]}},"response":[{"id":"a97515bd-86ab-444d-8f6c-fcf5845706ca","name":"First Factor UserName Password Step 1","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2145"},{"key":"Date","value":"Wed, 31 Jul 2019 22:20:33 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"authId\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoSW5kZXhWYWx1ZSI6IlNlY29uZEZhY3RvciIsIm90ayI6ImVvMzdicW5taGJvczB0cGtlbm03czduZjRkIiwiYXV0aEluZGV4VHlwZSI6InNlcnZpY2UiLCJyZWFsbSI6Ii8iLCJzZXNzaW9uSWQiOiIqQUFKVFNRQUNNRElBQkhSNWNHVUFDRXBYVkY5QlZWUklBQUpUTVFBQ01ERS4qZXlKMGVYQWlPaUpLVjFRaUxDSmpkSGtpT2lKS1YxUWlMQ0poYkdjaU9pSklVekkxTmlKOS5aWGxLTUdWWVFXbFBhVXBMVmpGUmFVeERTalpoV0VGcFQybEtUMVF3TlVaSmFYZHBXbGMxYWtscWIybFJWRVY1VDBWT1ExRjVNVWxWZWtreFRtbEpjMGx0Um5OYWVVazJTVzFTY0dOcFNqa3VMbVozWjJsS04wZDBRWEJ2WTNOMFgzRXpSR3hHVjJjdVFVOVRiVTFNV2xCWlMxWktXRjltTjBsMlZsOXRTalZzVkZBNU5HUnNTV1l0VEc1c1NEWnNTMjluV1RWV2NsWkplWGR1Y0RWYUxWTXhSVmRTTkVseGFtWk5RazFOTmxkUFEyZDZSa3BMVlhWYUxVODRSa1JZUkdObVpXTlVRMlJJYlhSdVpqVlhUMk0wZVRnek4yUk9iM3AxYzJJeGRFRlBObkUyTmpGU1ozQlVUUzFMZG1SdlJXMWtRVFZKTlY5eVEwUlpSMUJMTUZGME9HUk1kbXhKZG1aeVFUWmtUa1ZFU25sQ2RHRXRTMU5rTVhaSFUxQjJhR1p2TTNOV1pXOTFURUZyUlRobU5WaGtUR1JoWjJGMFR6UkROM28wWkVwVVdGRkNXSHAwYkZGRmJuaGZRMG93YmxkeFMxWnJNVVZCYlRGelREVnFZV3RrYkhjeE5HUjVaVWhyYkdkRU4zSnVVV2hvUTFRM1FVWTFaRTFUVDNaT1QyeFhNbTFPTUdvNU1GVm5TMGhaY0V0NmRqSlpZbk5tYzBnd2FtZE9lR05TZVRSc2VXeHVhWGRPYVhZeGVpMXlOVkpqVTB3eVJtbDJiREpwYURWbWRFODVjUzFhZURSWE0ydENiRWhTTTNsQldtOVRRaTFmVW5kblNtcDBWbXRIVDBrM2NIb3hMVlI1UjNSaWMyczBkVE5pVUVGTmJEQmhUM0JmVldWMkxWQldObGxuVXpkeVF6aE1NWHA2UXkxNVREQndNMWRpY0hKc1NWQlBWa0pVWmtScE1GVlJOREJ3VkRRMGEwWnNWVzltV2t4NFF6ZFplREpEUkhOaFJGZFRRMUZIZW5wVk9YZHRZMHR0UXpkWmEzcE1WR1ZVUm5CRWJVaDBjbkZQVG1oSlZsRnpPVzh5UmpJMWJqTnJjSGw1UW1WVlJURkViMVJTUVhNMFYxUXpZMHQzTFRCMllqZ3hkV0pyUTNoMmJWZ3hiV2RrYnpGdmF6UTBaWHBRVm5CeWRYcG5hRlJQUkZKT1lUaEhkV1JQYzA1ak0wTnZRamt5YkRoc1EwaDFjbHA2UkY5U01VVkNiVU5pUldJNFVEQnNjVlE0YlVOM1VVUTJTVXh3VVRaVFIwMVlibWh1VDJGaVNpNXZPRVI0YVRkRmJsZERjV1ZVV0c1aFRtSTBhbnBSLkZwVnZZa1hsMENSaEVlMzVPT2ppQUl5aFJuRkxNdTN1SnJDUmFNVGxHcWciLCJleHAiOjE1NjQ2MTE5MzMsImlhdCI6MTU2NDYxMTYzM30.f3sdppQkmWVfP2OqlVzJwFsqzpHBuf9h-WsGGcJrgUY\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"}],"_postman_id":"3271a2f8-ad00-42ea-b9cf-bce32d8238ea"},{"name":"First Factor UserName Password Step 2","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"eb0b2091-4842-4304-8316-c8edb810a650","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{userName}}\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"{{userPassword}}\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}],"variable":[]}},"response":[{"id":"e44220c9-4c55-4534-b462-61e1ce4871dd","name":"First Factor UserName Password Step 2","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"NameCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"User Name\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{userName}}\"\n }\n ],\n \"_id\": 0\n },\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": \"{{userPassword}}\"\n }\n ],\n \"_id\": 1\n }\n ],\n \"stage\": \"UsernamePassword\"\n}"},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2225"},{"key":"Date","value":"Wed, 31 Jul 2019 22:20:51 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"authId\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoSW5kZXhWYWx1ZSI6IlNlY29uZEZhY3RvciIsIm90ayI6ImdhcDRudHJoMG5scnZiYThwMW42b2JhbGk5IiwiYXV0aEluZGV4VHlwZSI6InNlcnZpY2UiLCJyZWFsbSI6Ii8iLCJzZXNzaW9uSWQiOiIqQUFKVFNRQUNNRElBQkhSNWNHVUFDRXBYVkY5QlZWUklBQUpUTVFBQ01ERS4qZXlKMGVYQWlPaUpLVjFRaUxDSmpkSGtpT2lKS1YxUWlMQ0poYkdjaU9pSklVekkxTmlKOS5aWGxLTUdWWVFXbFBhVXBMVmpGUmFVeERTalpoV0VGcFQybEtUMVF3TlVaSmFYZHBXbGMxYWtscWIybFJWRVY1VDBWT1ExRjVNVWxWZWtreFRtbEpjMGx0Um5OYWVVazJTVzFTY0dOcFNqa3VMa0YzV0VkQ1NXWllSM0Z4WkU5bFYxVk5kbXAzUmtFdU16QnFTMGhRUVZZd00wMXlRMmR6YXpGS1JqRnFablEyWlRGck1XbHpVR3RMUVU5M2FIZDZRalpuT1RWSFN6UnJUMjVTY2kxcE1WOHlUR3M1ZDNKM1RGaGtMVWRIWm5GR1VFbDZNbFF4VGxaV2QwUkNZamN4ZDJsb1EwdHdaRXc1U2psblVVZFFRamRSTUhKMU5XOU9SakZRYkZSdFgyd3RVMmRYYzFoMU5YVlliMFp6Y2xWd2RsQlRaa3RqZW5rd04xRkZVV1IxVWs4MmR5MXhVREpZVUdkUk9XWnBlbVpuUzNsYVFuQTNaSG8yVldKaGVEWmllVmgyZERGWE9IbFJOVlJqVjJ4MFRVdFRZaTEyV2t4bFJsVk9WSGxET1ZwWVYweGtNR2R0YUUxUVZqaHFOMmhvWkZkT2RubElObUUxYURkcWVGSlBSM1JmWmw5bGQycHJTV0YyY3pkeldGazJOQzExU0RKVE9WTXRhMU15TUZFNE5VUXdlWGhCZW1nd1dGZDRUbnBFU2pCNlpGUkRTVE4zWTBaT1ZYWXpiVlJJVDA4elJIaGpUVU40UTFwcFZsOW9VSFY2VlZsWmNESlNaakp6Y21WdlduSjBTQzF6ZVZOcWVWSk1UM2xMUlVWelpHcE9hVFp2WmxCUlUzaDRiazR4U1VoMmVWOVNiRFJMVVU5NFNYWkVOWHBCTVd3d00zVXRZVGxhYVVWNlRYbFhWRUZtYWpob2FtTkZZM0JmUzNWclIyVlFaRmRXUkROTVowSkpiWEJMYW5wSmJtUmZYM1ZhYkZCMldVZEdhR3h4YldkQ1JIZFBZWE5vWVV4dFJtNW1NbkZ5ZUVsQmEwOXVVWFJoWm0xNWJVdHNjek16VjFGM2NrRkpPVVJRU2kxNFdIZ3pVbTQ1VUVwRVZHVTNWV0V3WTJKaE4zVktVRXBZY0d4YVFqTnJZbGhrZWpaNFVscGpNVWRmUlVKMlNXcHJRV0ZEVkhCcWNFOHpNWGhyVGtReGRqTnNNVU4xUmxkS1J6QndSV2hXWkd4RE5FMHdUbVJNVlVWaFpEbDFNa05LUkMxQ01uRktYMGhEWW5aalJubEZNbEZoZUhGeVduZGZkMDV0VGxnM2RWa3pSMlJXVjA5ZlNrRjJZMFo0YVRCNlRWUlZUR3B4UTFKWVZYVnFUMlZJWldGUlJrcG1XRXhrTmpOdGVtOW1WVWhaUmpKSmR6ZGtjV0YwU1VGaFgxbHdSRVIyV20wM1ZUUXVlVzh3VWxWcGNWODNjakp2ZUVWdlMwczFVWE10UVEuQ3VnYkViV2QwRURTRkxXZ3M3aXRRbWo5dUdVOXdpWnRhODhIbTNhLW5qUSIsImV4cCI6MTU2NDYxMTkzMywiaWF0IjoxNTY0NjExNjMzfQ.-jhw-daCgreI2k4MtXgZbiKKROGEfiW4NZHPbdktBdE\",\n \"callbacks\": [\n {\n \"type\": \"ChoiceCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"SecondFactorChoice\"\n },\n {\n \"name\": \"choices\",\n \"value\": [\n \"Email\",\n \"SMS\"\n ]\n },\n {\n \"name\": \"defaultChoice\",\n \"value\": 0\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": 0\n }\n ],\n \"_id\": 2\n }\n ],\n \"stage\": \"SecondFactorChoice\"\n}"}],"_postman_id":"eb0b2091-4842-4304-8316-c8edb810a650"},{"name":"Second Factor Choice of MFA Step 3","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"7b50b5dd-994c-41eb-a47e-5acca4309ce9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"ChoiceCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"SecondFactorChoice\"\n },\n {\n \"name\": \"choices\",\n \"value\": [\n \"Email\",\n \"SMS\"\n ]\n },\n {\n \"name\": \"defaultChoice\",\n \"value\": 0\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": 0\n }\n ],\n \"_id\": 2\n }\n ],\n \"stage\": \"SecondFactorChoice\"\n}"},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}],"variable":[]}},"response":[{"id":"c20aaf3a-9c3a-44c9-99f6-371ee2503167","name":"Second Factor Choice of MFA Step 3","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"ChoiceCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"SecondFactorChoice\"\n },\n {\n \"name\": \"choices\",\n \"value\": [\n \"Email\",\n \"SMS\"\n ]\n },\n {\n \"name\": \"defaultChoice\",\n \"value\": 0\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": 0\n }\n ],\n \"_id\": 2\n }\n ],\n \"stage\": \"SecondFactorChoice\"\n}"},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2303"},{"key":"Date","value":"Wed, 31 Jul 2019 22:21:01 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"authId\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoSW5kZXhWYWx1ZSI6IlNlY29uZEZhY3RvciIsIm90ayI6IjJ2aTl1Nm05ZjViM2d0OGQ3ZXBnM3NnODE4IiwiYXV0aEluZGV4VHlwZSI6InNlcnZpY2UiLCJyZWFsbSI6Ii8iLCJzZXNzaW9uSWQiOiIqQUFKVFNRQUNNRElBQkhSNWNHVUFDRXBYVkY5QlZWUklBQUpUTVFBQ01ERS4qZXlKMGVYQWlPaUpLVjFRaUxDSmpkSGtpT2lKS1YxUWlMQ0poYkdjaU9pSklVekkxTmlKOS5aWGxLTUdWWVFXbFBhVXBMVmpGUmFVeERTalpoV0VGcFQybEtUMVF3TlVaSmFYZHBXbGMxYWtscWIybFJWRVY1VDBWT1ExRjVNVWxWZWtreFRtbEpjMGx0Um5OYWVVazJTVzFTY0dOcFNqa3VMbEUzY0VGSlFVRnVWMEZQTm1keE5Vc3hUakJNWDNjdVp6SnRiMHBhWVd0Q1psaFNjVXN0VkdaRVRrVmZWRWx1WTJJM1EzQTJPRk5LZG5jNFdGcGlVRGh5VFZsb05EaGZjakpXYzNkb1NrcFlSbFpYWlRGVFYyRnpaa1pvYlZreFp6ZFNjVzFVY2tGbFJIZDVVMHh4UlRoalV6RktWRVpLU1dnMFgyTndMWGQxYnpOMVozY3lWbVY1VVhablltOXJRbHBqTVVGWFkwWnhRbUZPZFU5MVRWQndURFEwZW1aalpWWXlWa1JYY0c1WlRGbHpZbkl6VW1SV1ZIZFFTSHBVYVVWNk1UVjFMWGxWZWtZMU9UaFFiM0kwWWxoVmNEQm9jMmR0TkRaMlNXbFhUa2d4TjI1Q1RtaEZTbHBqYmtsWFYyeFlUbkZuVjJveU9ITlZWMFZQVjA5TU1FcGFjbVJ0VEROUVFsRjBkVzlUVkZaNWFIQk9aR04yVkdkQlRFOTZhSFZPZW5Gb1MxbHBaWFExWldSRkxUUklWR2hCWm14T1puSjVRbkk1Y1dsMFVVeG5VMUJPTWpkWFZVTjRaRk14YTBkVVpGWkVjemQ0WVVKNlIxQldVRXgwVXpWd2EwTkpaemRVWmtZMmJXNW9iVUpwU0ZOb1VVWkVSeTFsUTJac1dFbEhURkJzV0RORk4zTlFObWxDVlRGS2JWRkpWR294WkY5Wk1rUkZNbkZIWVdaclZXdFdNVTVoZERnNGNtdGxSR3RWVFhGUE4xQkZNa1JDYms0MVNuSTNORTB0ZW1sSmVWQmFNV05PUTNwWU1uRnliM1EwUTFaSVNVRlZkMDFHYlhwRVJUTXpWbFY2TmxKbk1qQndNRVUzYVhOR1JYRkRTMUZ2TlhkWVYxOUROazltV2pCRlZYUlRjek5uV1c5MmVXbExhVEptT1VOMldpMXJhbWxTYzB0dFgwbzBaV1ZhZVRCRGMyOWhPVEpXTVROVVowMW9UbGgyV1hORmF6bExUR0Y0T0dKeFV6ZzVObEI0VVhnelduaGlZVmR3WXpNeVZFcGlXVWxWUW5kRFIxQXRibXd4ZUY5dlpUZHFSRFY1WVZVM2NEWjRRM28zWnpKZmVuZ3RWRUZ1Um1WdGVHVmFaMlp1WmxwclZWRlhiVGMzZVdkUlZ6WjFkMU5HTUZOSVJsZHRVbWhyUzNoM00zWmZUa2hUWW14NllUQkdVRzltUkdzd2EzQXpRakJrTUdnNU1HbEZMVTl6V2tOVlRrazFOVFpoZUdObVZXTjVhMUprVlU5eE5IUjRibUp0WnpGaWJsbGlRa2xRTURCWVYzSkhWMDl4U25nMGNGUXRaRE5CY1ZSTVJVSTNTMFYxTW1kelJ6bHNWbkpFVTNSalRITlRWbkUzV0V0aWVtRnlOSEZ1UTFScFRGZE9iSGRTWnk1aGFXdHpRMnc0TkRsTVNUWlJXaTB0ZVdOUGVIRlIuc19jSjdLWDN0eXg4YVg4eEJoXzB5Y0xnMVo3Q25Xd2pfYXFnbFc5X0xrSSIsImV4cCI6MTU2NDYxMTkzMywiaWF0IjoxNTY0NjExNjMzfQ.1R5C6knc-S8avY8fVbSjEFBloq39pJn1boh5VNNz-e4\",\n \"callbacks\": [\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"One Time Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"\"\n }\n ],\n \"_id\": 0\n }\n ],\n \"stage\": \"OneTimePasswordEmail\"\n}"}],"_postman_id":"7b50b5dd-994c-41eb-a47e-5acca4309ce9"},{"name":"Second Factor Response Step 4","event":[{"listen":"test","script":{"id":"82337149-a08b-4c1c-9840-bc1e97c4377c","exec":[""],"type":"text/javascript"}}],"id":"ddfa0ce0-01ea-4a04-8120-11bfdc7aacab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"One Time Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{OneTimePasscode}}\"\n }\n ],\n \"_id\": 0\n }\n ],\n \"stage\": \"OneTimePasswordEmail\"\n}"},"url":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","description":"

Gets the SSO Token for the user, also known as the iPlanetDirectoryPro token.

\n","urlObject":{"path":["json","realms","root","authenticate"],"host":["{{amUrl}}"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}],"variable":[]}},"response":[{"id":"1c9acc99-a589-4f28-bd17-2ee0f4884a71","name":"Second Factor Response Step 4","originalRequest":{"method":"POST","header":[{"key":"Accept-API-Version","value":"resource=2.0,protocol=1.0"},{"key":"Host","value":"openam","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"PasswordCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"One Time Password\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{OneTimePasscode}}\"\n }\n ],\n \"_id\": 0\n }\n ],\n \"stage\": \"OneTimePasswordEmail\"\n}"},"url":{"raw":"{{amUrl}}/json/realms/root/authenticate?authIndexType=service&authIndexValue=SecondFactor","host":["{{amUrl}}"],"path":["json","realms","root","authenticate"],"query":[{"key":"authIndexType","value":"service"},{"key":"authIndexValue","value":"SecondFactor"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Set-Cookie","value":"iPlanetDirectoryPro=2witApVgJdv77T_yCV2t4pE9eUw.*AAJTSQACMDIAAlNLABw4NGhkaVJKcUpiMWNLcnRsZU9oUzFrZ0FzVVk9AAR0eXBlAANDVFMAAlMxAAIwMQ..*; Path=/"},{"key":"Set-Cookie","value":"amlbcookie=01; Path=/"},{"key":"Content-API-Version","value":"resource=2.1"},{"key":"Expires","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"164"},{"key":"Date","value":"Wed, 31 Jul 2019 22:22:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"tokenId\": \"2witApVgJdv77T_yCV2t4pE9eUw.*AAJTSQACMDIAAlNLABw4NGhkaVJKcUpiMWNLcnRsZU9oUzFrZ0FzVVk9AAR0eXBlAANDVFMAAlMxAAIwMQ..*\",\n \"successUrl\": \"/console\",\n \"realm\": \"/\"\n}"}],"_postman_id":"ddfa0ce0-01ea-4a04-8120-11bfdc7aacab"}],"id":"852cd850-fbb0-47e8-957c-f4662e6a1e24","description":"

The API calls for the SecondFactor Authentication flow follow the same path our JavaScript SDK for SecondFactor do to authenticate a user and uses Email as the chosen method to receive the SecondFacor.

\n

To successfully authenticate with this API collection, you will need access the email address associated with the authenticating user's profile. And you will need to collect the code send in the email and populate the OneTimePassword prior to the POST call on Step 4.

\n

A successful outcome returns a users session token. Our postman collection stores this in a postman environment variable called sessionToken which are used to get an access_token and IdToken for the authenticated user.

\n","event":[{"listen":"prerequest","script":{"id":"57fb45bd-3d8b-44d1-beb6-f4a2cce1a9f7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a7061a2-f26f-4e1b-a8cf-a6a7f8c9d61b","type":"text/javascript","exec":[""]}}],"_postman_id":"852cd850-fbb0-47e8-957c-f4662e6a1e24","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}}],"id":"35883cd0-516d-41ce-91eb-895cefe6efb5","description":"

You can use the Authtication APIs to authenticate a user for Express . These APIs will return what we call a session token. When a session token is returned via these APIs, our scripts store them in a variable called sessionToken which is used to obtain an access_token.

\n","event":[{"listen":"prerequest","script":{"id":"91333bb8-7e8f-4d92-b66b-0023da20fbea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"51b3c355-ae8c-47e1-85bc-fa833023ce84","type":"text/javascript","exec":["var json = JSON.parse(responseBody);","","if (json.authId) { "," pm.environment.set(\"authId\", json.authId);"," console.log(`set authId: ${json.authId}`);","}","if (json.tokenId) { "," pm.environment.set(\"sessionToken\",json.tokenId);"," console.log(`set sessionToken : ${json.tokenId}`);","}"]}}],"_postman_id":"35883cd0-516d-41ce-91eb-895cefe6efb5","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Get Access Token - Native or SPA Apps","item":[{"name":"Get Authorization Code using PKCE","event":[{"listen":"test","script":{"id":"2e66db2f-2168-4660-9874-aca5853178d7","exec":["var url = require('url');","","var resplocation = pm.response.headers.find(x => x.key.toLowerCase() === 'location');","if (!resplocation) {"," console.log('Failed to get redirect location');"," return;","}","","var parsedUrl = url.parse(resplocation.value, true);","if (!parsedUrl.query.code) {"," console.log('Failed to get authorization code');"," return;","}","","pm.environment.set('authorizationCode', parsedUrl.query.code);","console.log(`set authorizationCode = ${parsedUrl.query.code}`);"],"type":"text/javascript"}}],"id":"1e96c2b8-5ed9-4a93-9731-2955726adbcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Cookie","type":"text","value":"iPlanetDirectoryPro={{sessionToken}}"}],"url":"{{oauth2Url}}/authorize?grant_type=authorization_code&client_id={{natspaClientId}}&response_type=code&scope={{natspaScopes}}&redirect_uri=https://example.com/homeLogin/&code_challenge=j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y&code_challenge_method=S256&state=abc123","description":"

Uses the session token and SPA Client ID to produces an authorization code. This authorizatoin code is used in the next API call to exchange it for the user's access token

\n

Note: A 302 message is expected; this REST call includes a script which reads authorization code from the result and sets a postman variable authorizationCode to be used in the next API call in this collection.

\n","urlObject":{"path":["authorize"],"host":["{{oauth2Url}}"],"query":[{"key":"grant_type","value":"authorization_code"},{"key":"client_id","value":"{{natspaClientId}}"},{"key":"response_type","value":"code"},{"key":"scope","value":"{{natspaScopes}}"},{"key":"redirect_uri","value":"https://example.com/homeLogin/"},{"key":"code_challenge","value":"j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y"},{"key":"code_challenge_method","value":"S256"},{"key":"state","value":"abc123"}],"variable":[]}},"response":[{"id":"c313a7f6-e1e8-4f25-b86b-28d759dc0972","name":"Get Authorization Code using PKCE","originalRequest":{"method":"GET","header":[{"key":"Cookie","type":"text","value":"iPlanetDirectoryPro={{sessionToken}}"}],"url":{"raw":"{{oauth2Url}}/authorize?grant_type=authorization_code&client_id={{natspaClientId}}&response_type=code&scope={{natspaScopes}}&redirect_uri=https://example.com/homeLogin/&code_challenge=j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y&code_challenge_method=S256&state=abc123","host":["{{oauth2Url}}"],"path":["authorize"],"query":[{"key":"grant_type","value":"authorization_code"},{"key":"client_id","value":"{{natspaClientId}}"},{"key":"response_type","value":"code"},{"key":"scope","value":"{{natspaScopes}}"},{"key":"redirect_uri","value":"https://example.com/homeLogin/"},{"key":"code_challenge","value":"j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y"},{"key":"code_challenge_method","value":"S256"},{"key":"state","value":"abc123"}]}},"status":"Found","code":302,"_postman_previewlanguage":"plain","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Location","value":"https://example.com/homeLogin/?code=CNSo0MmVgFixISR4mbuRpXsmflk&iss=https://openam-spark0730.forgeblocks.com/am/oauth2&state=abc123&client_id=ce96880e4516809005e583972f690874"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Wed, 31 Jul 2019 20:42:57 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1e96c2b8-5ed9-4a93-9731-2955726adbcc"},{"name":"Exchange Authorization Code to Access Token ","event":[{"listen":"test","script":{"id":"03ed5da3-1376-4c70-8e80-4e148b029890","exec":["var json = JSON.parse(responseBody);","","if (json.access_token) { "," pm.environment.set(\"accessToken\",json.access_token);"," console.log(`set accessToken: ${json.access_token}`);"," console.log(`scope is: ${json.scope}`);","}","","if (json.id_token) { "," pm.environment.set(\"idToken\",json.id_token);"," console.log(`set idToken: ${json.id_token}`);","}","","if (json.refresh_token) { "," pm.environment.set(\"refreshToken\",json.refresh_token);"," console.log(`set refreshToken: ${json.refresh_token}`);","}"],"type":"text/javascript"}}],"id":"5ad76a19-f903-43e9-9bb5-7bc2de7e1376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"code","value":"{{authorizationCode}}","type":"text"},{"key":"client_id","value":"{{natspaClientId}}","type":"text"},{"key":"redirect_uri","value":"https://example.com/homeLogin/","type":"text"},{"key":"code_verifier","value":"ZpJiIM_G0SE9WlxzS69Cq0mQh8uyFaeEbILlW8tHs62SmEE6n7Nke0XJGx_F4OduTI4","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

Takes the authorization code from step 2, along with the Native/SPA app client ID, to get the access token using Proof Key for Code Exchange (PKCE).

\n

To enhance security, the REST call uses a unique authorization code instead of the app client secret.

\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"09e69471-2019-4941-b6a2-8689b4f8cb03","name":"Exchange Authorization Code to Access Token ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"code","value":"{{authorizationCode}}","type":"text"},{"key":"client_id","value":"{{natspaClientId}}","type":"text"},{"key":"redirect_uri","value":"https://example.com/homeLogin/","type":"text"},{"key":"code_verifier","value":"ZpJiIM_G0SE9WlxzS69Cq0mQh8uyFaeEbILlW8tHs62SmEE6n7Nke0XJGx_F4OduTI4","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"4530"},{"key":"Date","value":"Wed, 31 Jul 2019 20:43:13 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMDIyOSIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoiYWNjZXNzX3Rva2VuIiwidG9rZW5fdHlwZSI6IkJlYXJlciIsImF1dGhHcmFudElkIjoid05wTllMQ3BvVm1qUVlaLTNmczIyUFNIMFVrIiwiYXVkIjoiY2U5Njg4MGU0NTE2ODA5MDA1ZTU4Mzk3MmY2OTA4NzQiLCJuYmYiOjE1NjQ2MDU3OTMsImdyYW50X3R5cGUiOiJhdXRob3JpemF0aW9uX2NvZGUiLCJzY29wZSI6WyJ1c2VyLnJlYWQiLCJtZS5yZWFkIiwidXNlci5jcmVhdGUiLCJwYXNzd29yZC1wb2xpY3kucmVhZCIsIm9wZW5pZCIsIm1lLnVwZGF0ZSIsInByb2ZpbGUiLCJtZS51cGRhdGUtcGFzc3dvcmQiLCJlbWFpbCIsInVzZXIucmVjb3Zlci11c2VybmFtZSIsInVzZXIucmVzZXQtcGFzc3dvcmQiXSwiYXV0aF90aW1lIjoxNTY0NjA1NTA2LCJyZWFsbSI6Ii8iLCJleHAiOjE1NjQ2MDkzOTMsImlhdCI6MTU2NDYwNTc5MywiZXhwaXJlc19pbiI6MzYwMCwianRpIjoiaHdFc051WG1WMEJpQWwzMDNteUtUNzJ1dXIwIn0.uMvs8dfkIuxbCN9Lkjx4w0QH_caTGHApBPxZFUu8_sQmu1OoPrGr6FhY2Jf1roX0Uw5VGJAbNEz-Oi4pCrSuR49uRtTjtLRs5SMHeXsX4Bm4uFwSYFCI1JOjutbmii91LY_DazZ2eYcp6yRaWAW_u2mtonfIRMHXjTdZ9O6JXVG0uv4SNFeJ8T9fUMt03B6jKwBfexcg90ppdz8kVJ8OQ1_5ux_WnSpsrCRe5a_xP3pTqkw3h4bzt9-8AV2nd3sGNmI2tEHE1KxHHlenD73HCs5YVPtozo00f-M2HMvIAbgphnmagtQAmZ9b3PRSPScj6s9bYkJvL21OrjUcOG0zWA\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMDIyOCIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoicmVmcmVzaF90b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6IndOcE5ZTENwb1ZtalFZWi0zZnMyMlBTSDBVayIsImF1ZCI6ImNlOTY4ODBlNDUxNjgwOTAwNWU1ODM5NzJmNjkwODc0IiwiYWNyIjoiMCIsIm5iZiI6MTU2NDYwNTc5Mywib3BzIjoiMWV0ZkFrdjhNU2QwclFLRzR3akNQTUpBa3NNIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbInVzZXIucmVhZCIsIm1lLnJlYWQiLCJ1c2VyLmNyZWF0ZSIsInBhc3N3b3JkLXBvbGljeS5yZWFkIiwib3BlbmlkIiwibWUudXBkYXRlIiwicHJvZmlsZSIsIm1lLnVwZGF0ZS1wYXNzd29yZCIsImVtYWlsIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQ2MDU1MDYsInJlYWxtIjoiLyIsImV4cCI6MTU2NTIxMDU5MywiaWF0IjoxNTY0NjA1NzkzLCJleHBpcmVzX2luIjo2MDQ4MDAsImp0aSI6IlNWSUN1a2UxcFpaMnpHa2loWV81UFlLYjdLbyJ9.w_6GddPtzOcyOn9EzYo0Uuhh6TqyfCK0ni0kzn0XT1fwUko-gmOwj2GkF8wKkKqlwBkBj-vai9pDWo1UCQEK4cnpx3W-aiBgh2NrRflCxmWxyhz05kHwtLDfkOVBaAxIK-whMfLSxure3g6pNveVRzCRrEIcGunzaq6451MCNhAlf-oF8PrQZoNnoKQx3pAjPbbh1XNqRwF4LpTDa3gbkqJDNhnzMmnCPFrtjUErI1DtlPb8nd71vKKe8sI_RFX8-7zOWsvi3wpkm5ht2ka-OI-O-0GjtGc3vsumF3jfosfbybtVy1xHfiC1eQwVDS9RfgCRknJxa6XLYbi0lXza8g\",\n \"scope\": \"user.read me.read user.create password-policy.read openid me.update profile me.update-password email user.recover-username user.reset-password\",\n \"id_token\": \"eyJ0eXAiOiJKV1QiLCJraWQiOiJ3VTNpZklJYUxPVUFSZVJCL0ZHNmVNMVAxUU09IiwiYWxnIjoiUlMyNTYifQ.eyJhdF9oYXNoIjoiTG5kY19wQmpRRWtvbUc3bFdNOGYtZyIsInN1YiI6ImJqZW5zZW5AZXhhbXBsZS5jb20iLCJ6b25laW5mbyI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJhdWRpdFRyYWNraW5nSWQiOiIwZWIyODEzMC1jN2VkLTQwNWMtYTNmMy0yMGFiYmVkNzQ2ZGMtMjAyMzEiLCJpc3MiOiJodHRwczovL29wZW5hbS1zcGFyazA3MzAuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImlkX3Rva2VuIiwibG9jYWxlIjoiZW4tVVMiLCJ0aXRsZSI6Ik1hc3RlciBDYXJwZW50ZXIiLCJhY3IiOiIwIiwiYXpwIjoiY2U5Njg4MGU0NTE2ODA5MDA1ZTU4Mzk3MmY2OTA4NzQiLCJhdXRoX3RpbWUiOjE1NjQ2MDU1MDYsIm5pY2tuYW1lIjoiQmFicyIsImV4cCI6MTU2NDYwOTM5MywiaWF0IjoxNTY0NjA1NzkzLCJlbWFpbCI6ImJhYnNAamVuc2VuLm9yZyIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJvZmlsZSI6Imh0dHBzOi8vbG9naW4uZXhhbXBsZS5jb20vYmplbnNlbiIsImdpdmVuX25hbWUiOiJCYXJiYXJhIiwibWlkZGxlX25hbWUiOiJKYW5lIiwiYXVkIjoiY2U5Njg4MGU0NTE2ODA5MDA1ZTU4Mzk3MmY2OTA4NzQiLCJjX2hhc2giOiJ1NW9XWW9qdFJXZUNFMWx6eV9laE9RIiwib3JnLmZvcmdlcm9jay5vcGVuaWRjb25uZWN0Lm9wcyI6IjFldGZBa3Y4TVNkMHJRS0c0d2pDUE1KQWtzTSIsInNfaGFzaCI6ImJLRTlVc3B3eUlQZzhMc1FIa0phaVEiLCJuYW1lIjoiQmFyYmFyYSBKYW5lIEplbnNlbiIsInJlYWxtIjoiLyIsInRva2VuVHlwZSI6IkpXVFRva2VuIiwiZmFtaWx5X25hbWUiOiJKZW5zZW4ifQ.MVegZSIhlu92uFZGiegGN0WNeW_6o3HvnV6bKDE_MmA-FcZH_SfIqIqL1WmohizIGzXhGZ29X6WxYvfMdSmMUt1dLesf7nEH3kq9yZmKJaIjxJrqjb2-yh8un3fRHFQBw-DCOXcF1ygYFcVUndwkUnuFDg9JqWMCU-I-Yvp93k_fSENzmcYcx72OZI9zUNoWIikvNs3XN-QoFi7kRXmJa9OXuWJbkVTyPd8RCxCuWu15Nqam_DI4-0Z-krpLf53obTHJ8wl3JfaQpeg1jutVaZw8B94IVyF6ZuCWwefxXDGNkFBW9wHhV1qSIDrYf3Hg_6ksPRiAABQbK7auTGeEFQ\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"5ad76a19-f903-43e9-9bb5-7bc2de7e1376"}],"id":"dcaa89c6-edac-44cc-9ec5-2835cfeb8188","description":"

You are able to obtain an access token for these types of apps using these APIs. Unlike Web Apps, Native/Spa apps are unable to store a client secret. For confidential clients such as Native/SPA apps we can obtain an access token by making the following requests using the PKCE standard.

\n

For this example we've defined an arbitrary value for the code_verifier, with a corresponding value for code_challenge in your application you will need to generate values for both code_verifier and code_challenge

\n","event":[{"listen":"prerequest","script":{"id":"a8430055-c7b2-4532-94dd-222c6f819613","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d13e0df-9833-4645-a9f8-3fc97dde5069","type":"text/javascript","exec":[""]}}],"_postman_id":"dcaa89c6-edac-44cc-9ec5-2835cfeb8188","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Get Access Token - Web Apps","item":[{"name":"Get Authorization Code using PKCE","event":[{"listen":"test","script":{"id":"2e66db2f-2168-4660-9874-aca5853178d7","exec":["var url = require('url');","","var resplocation = pm.response.headers.find(x => x.key.toLowerCase() === 'location');","if (!resplocation) {"," console.log('Failed to get redirect location');"," return;","}","","var parsedUrl = url.parse(resplocation.value, true);","if (!parsedUrl.query.code) {"," console.log('Failed to get authorization code');"," return;","}","","pm.environment.set('authorizationCode', parsedUrl.query.code);","console.log(`set authorizationCode = ${parsedUrl.query.code}`);"],"type":"text/javascript"}}],"id":"cc61aef2-2e08-4c9c-812b-93e7ed49a230","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{oauth2Url}}/authorize?grant_type=authorization_code&client_id={{webClientId}}&response_type=code&scope={{webScopes}}&redirect_uri=https://example.com/homeLogin/&code_challenge=j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y&code_challenge_method=S256&state=abc123","description":"

Uses the SSO token and web app credentials to produce an authorization code.

\n

Note: A 302 message is expected; this REST call includes a script which pulls the authorization code from the verbose output for step 3.

\n","urlObject":{"path":["authorize"],"host":["{{oauth2Url}}"],"query":[{"key":"grant_type","value":"authorization_code"},{"key":"client_id","value":"{{webClientId}}"},{"key":"response_type","value":"code"},{"key":"scope","value":"{{webScopes}}"},{"key":"redirect_uri","value":"https://example.com/homeLogin/"},{"key":"code_challenge","value":"j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y"},{"key":"code_challenge_method","value":"S256"},{"key":"state","value":"abc123"}],"variable":[]}},"response":[{"id":"f3106530-7237-4999-ba44-5a1f5ad9c991","name":"Get Authorization Code using PKCE","originalRequest":{"method":"GET","header":[{"key":"Cookie","type":"text","value":"iPlanetDirectoryPro={{sessionToken}}","disabled":true}],"url":{"raw":"{{oauth2Url}}/authorize?grant_type=authorization_code&client_id={{webClientId}}&response_type=code&scope={{webScopes}}&redirect_uri=https://example.com/homeLogin/&code_challenge=j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y&code_challenge_method=S256&state=abc123","host":["{{oauth2Url}}"],"path":["authorize"],"query":[{"key":"grant_type","value":"authorization_code"},{"key":"client_id","value":"{{webClientId}}"},{"key":"response_type","value":"code"},{"key":"scope","value":"{{webScopes}}"},{"key":"redirect_uri","value":"https://example.com/homeLogin/"},{"key":"code_challenge","value":"j3wKnK2Fa_mc2tgdqa6GtUfCYjdWSA5S23JKTTtPF8Y"},{"key":"code_challenge_method","value":"S256"},{"key":"state","value":"abc123"}]}},"status":"Found","code":302,"_postman_previewlanguage":"plain","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Location","value":"https://example.com/homeLogin/?code=K5E3V5OgcVrZu-gHaQKXecGMvoo&iss=https://openam-spark0730.forgeblocks.com/am/oauth2&state=abc123&client_id=c267d5eb2006729a21f74ddb37655986"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Wed, 31 Jul 2019 20:40:44 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cc61aef2-2e08-4c9c-812b-93e7ed49a230"},{"name":"Exchange Authorization Code to Access Token","event":[{"listen":"test","script":{"id":"57286108-84c5-4399-87e7-4cf9c05688a4","exec":["var json = JSON.parse(responseBody);","","if (json.access_token) { "," pm.environment.set(\"accessToken\",json.access_token);"," console.log(`set accessToken: ${json.access_token}`);"," console.log(`scope is: ${json.scope}`);","}","","if (json.id_token) { "," pm.environment.set(\"idToken\",json.id_token);"," console.log(`set idToken: ${json.id_token}`);","}","","if (json.refresh_token) { "," pm.environment.set(\"refreshToken\",json.refresh_token);"," console.log(`set refreshToken: ${json.refresh_token}`);","}"],"type":"text/javascript"}}],"id":"b350e9ba-031f-490b-9375-bc81321059df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{webSecret}}","username":"{{webClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"code","value":"{{authorizationCode}}","type":"text"},{"key":"client_id","value":"{{webClientId}}","type":"text"},{"key":"redirect_uri","value":"https://example.com/homeLogin/","type":"text"},{"key":"code_verifier","value":"ZpJiIM_G0SE9WlxzS69Cq0mQh8uyFaeEbILlW8tHs62SmEE6n7Nke0XJGx_F4OduTI4","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

Takes the authorization code from step 2, along with the Web app client ID, to get the access token using Proof Key for Code Exchange (PKCE).

\n

To enhance security, the REST call uses a unique authorization code.

\n

Even though the REST call includes the base64 encoding of the client ID and client secret, PKCE enhances security for web apps, as it prevents a malicious user from using:

\n
    \n
  • An intercepted authorization code
    • \n
  • Data from a request to the /authorize endpoint (as shown in step 2)
    • \n
\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"1724f2ee-488a-4580-bced-e3ffdea567e1","name":"Exchange Authorization Code to Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"code","value":"{{authorizationCode}}","type":"text"},{"key":"client_id","value":"{{webClientId}}","type":"text"},{"key":"redirect_uri","value":"https://example.com/homeLogin/","type":"text"},{"key":"code_verifier","value":"ZpJiIM_G0SE9WlxzS69Cq0mQh8uyFaeEbILlW8tHs62SmEE6n7Nke0XJGx_F4OduTI4","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"4530"},{"key":"Date","value":"Wed, 31 Jul 2019 20:41:04 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMDAwMyIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoiYWNjZXNzX3Rva2VuIiwidG9rZW5fdHlwZSI6IkJlYXJlciIsImF1dGhHcmFudElkIjoiR0FYQjh3WXJwdU5aM3dfSER3YUxkMnRRSjdzIiwiYXVkIjoiYzI2N2Q1ZWIyMDA2NzI5YTIxZjc0ZGRiMzc2NTU5ODYiLCJuYmYiOjE1NjQ2MDU2NjQsImdyYW50X3R5cGUiOiJhdXRob3JpemF0aW9uX2NvZGUiLCJzY29wZSI6WyJvcGVuaWQiLCJtZS51cGRhdGUiLCJwcm9maWxlIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZWFkIiwibWUucmVhZCIsInVzZXIuY3JlYXRlIiwicGFzc3dvcmQtcG9saWN5LnJlYWQiLCJtZS51cGRhdGUtcGFzc3dvcmQiLCJlbWFpbCIsInVzZXIucmVzZXQtcGFzc3dvcmQiXSwiYXV0aF90aW1lIjoxNTY0NjA1NTA2LCJyZWFsbSI6Ii8iLCJleHAiOjE1NjQ2MDkyNjQsImlhdCI6MTU2NDYwNTY2NCwiZXhwaXJlc19pbiI6MzYwMCwianRpIjoiaUNzaU1MM2UwQWdMMnlqUGFMZTVja2ZPMUpVIn0.zn92RKz6yrsVjlnxE47_2CoUVvFvH1OsGLJry9vVD_3heLSlzHVGfQuFpS86r8pB6mhDgZkiTMVP1JAXlcTIOHkz2Ctt2k0aMj1Zp2K0Z72EQYceDuj6oGH1Y6jnxJKLM5uuGvDPHuWdvdStvQWmJh9wyOh7Ti3KDQ9uEtIfjgTSqr7oqXfK015JNF7UVAAxXZOKotAUuMMyMp9muNBiyYo8a1zYFSMNk-T6SAyIh63YUWBfWnLbw8XhwS9TYwDQDZ6vXAPzbYrDK85aavcHDLTRVl3t1jyM1nb7y1hA8cRc3-Y4i2rWEJK1eGFTfq2zAJaLcnTX6Z_qxoU2Oq61GA\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMDAwMiIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoicmVmcmVzaF90b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6IkdBWEI4d1lycHVOWjN3X0hEd2FMZDJ0UUo3cyIsImF1ZCI6ImMyNjdkNWViMjAwNjcyOWEyMWY3NGRkYjM3NjU1OTg2IiwiYWNyIjoiMCIsIm5iZiI6MTU2NDYwNTY2NCwib3BzIjoialdwQnotdHB5SFFBdjJKRmZIVzlJeTRXVEswIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbIm9wZW5pZCIsIm1lLnVwZGF0ZSIsInByb2ZpbGUiLCJ1c2VyLnJlY292ZXItdXNlcm5hbWUiLCJ1c2VyLnJlYWQiLCJtZS5yZWFkIiwidXNlci5jcmVhdGUiLCJwYXNzd29yZC1wb2xpY3kucmVhZCIsIm1lLnVwZGF0ZS1wYXNzd29yZCIsImVtYWlsIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQ2MDU1MDYsInJlYWxtIjoiLyIsImV4cCI6MTU2NTIxMDQ2NCwiaWF0IjoxNTY0NjA1NjY0LCJleHBpcmVzX2luIjo2MDQ4MDAsImp0aSI6IjY0QmNyVzNDVklJakl6OUxDYjdBeXIwSmNOYyJ9.lR5ChgkVhKUKZEuwZlKscGEs8QJqqN9AU0X82U7rNOPWzNGixRpp6MiKDP1YjtYzXRSru2lYaJ3-ImvnMqT1s9MhGVyRr9bcB-4mVCJLXBw2k9rkX8dbRpMSpkSVojLn11eWf85lYJ2PB7JLoDLwPOXNfYbMmWCsyxowoqRPJCn1xZp49N-PJ0sDfPKEydweIGCkpMjCbIcmYXDg66_NKtk6HgkGaJZ0mGlfWWoUdFWACNEtebWdkwmxB2RbGVGxW_gXoGaAeoOHNMk-Um9qS9LgvyRrJDno61L0iDDVOqkj7Yo-dmaw6Wh_2szuQisiTUT-nJj3KW6os5s1SFQM8w\",\n \"scope\": \"openid me.update profile user.recover-username user.read me.read user.create password-policy.read me.update-password email user.reset-password\",\n \"id_token\": \"eyJ0eXAiOiJKV1QiLCJraWQiOiJ3VTNpZklJYUxPVUFSZVJCL0ZHNmVNMVAxUU09IiwiYWxnIjoiUlMyNTYifQ.eyJhdF9oYXNoIjoiMWNBYnNnaDlEVEhCQmJzQ25JbGJoZyIsInN1YiI6ImJqZW5zZW5AZXhhbXBsZS5jb20iLCJ6b25laW5mbyI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJhdWRpdFRyYWNraW5nSWQiOiIwZWIyODEzMC1jN2VkLTQwNWMtYTNmMy0yMGFiYmVkNzQ2ZGMtMjAwMDYiLCJpc3MiOiJodHRwczovL29wZW5hbS1zcGFyazA3MzAuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImlkX3Rva2VuIiwibG9jYWxlIjoiZW4tVVMiLCJ0aXRsZSI6Ik1hc3RlciBDYXJwZW50ZXIiLCJhY3IiOiIwIiwiYXpwIjoiYzI2N2Q1ZWIyMDA2NzI5YTIxZjc0ZGRiMzc2NTU5ODYiLCJhdXRoX3RpbWUiOjE1NjQ2MDU1MDYsIm5pY2tuYW1lIjoiQmFicyIsImV4cCI6MTU2NDYwOTI2NCwiaWF0IjoxNTY0NjA1NjY0LCJlbWFpbCI6ImJhYnNAamVuc2VuLm9yZyIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJvZmlsZSI6Imh0dHBzOi8vbG9naW4uZXhhbXBsZS5jb20vYmplbnNlbiIsImdpdmVuX25hbWUiOiJCYXJiYXJhIiwibWlkZGxlX25hbWUiOiJKYW5lIiwiYXVkIjoiYzI2N2Q1ZWIyMDA2NzI5YTIxZjc0ZGRiMzc2NTU5ODYiLCJjX2hhc2giOiJpOEdZRzRJb0xCcWE4QldNZUItVnNnIiwib3JnLmZvcmdlcm9jay5vcGVuaWRjb25uZWN0Lm9wcyI6ImpXcEJ6LXRweUhRQXYySkZmSFc5SXk0V1RLMCIsInNfaGFzaCI6ImJLRTlVc3B3eUlQZzhMc1FIa0phaVEiLCJuYW1lIjoiQmFyYmFyYSBKYW5lIEplbnNlbiIsInJlYWxtIjoiLyIsInRva2VuVHlwZSI6IkpXVFRva2VuIiwiZmFtaWx5X25hbWUiOiJKZW5zZW4ifQ.KPVl6VUTi0do5YzU5fXfDbSVGpzmQCEylamWbiKYaghaunckNuYnwR2e9GhTgXZ-6dB-j9SIcL-CZfc8R0JgG-NbVhwQhADSC4zn5_bVTCQrUF0C6m_N7mA4ghjgmUZCDhIdElGp8o6VuFNRqWIVETMNXo8DXTVO3XHEq4H4GV3OtpTR84BKuiK344cCtbp9_FGkvf37YPRrsLv5z7JUlikJONTqCN-4r-MKfjM0ypzqnkuWpfEZW6XLxbt2WGF2f8Vf8Vad6K1F_sijxwJ4Kd-QqGvi4OA8Mc6OEdasg51DBlRRmdNi1jACM8k7Eowco_E3c4pojIGzrtgGQjyyZA\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"b350e9ba-031f-490b-9375-bc81321059df"}],"id":"f2b7fbea-6db8-4fa0-8f16-6c7684ada3fa","description":"

This section helps secure access tokens without client secrets.

\n

For Native/SPA apps, this is critical; otherwise, client secrets would be stored on end-user devices and browsers.

\n

For Web apps, it reduces risks, as malicious users can't use an intercepted authentication code.

\n

Security is ensured by a code_verifier and code_challenge. A code_verifier is a cryptographically random string. The code_challenge depends on the value of code_challenge_method.

\n
    \n
  • If code_challenge_method = plain, code_challenge = code_verifier.
    • \n
  • If code_challenge_method = S256, code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))).
    • \n
\n

For the purpose of this REST collection, we've set up an arbitrary value for the code_verifier, with a corresponding value for code_challenge.

\n","event":[{"listen":"prerequest","script":{"id":"a8430055-c7b2-4532-94dd-222c6f819613","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d13e0df-9833-4645-a9f8-3fc97dde5069","type":"text/javascript","exec":[""]}}],"_postman_id":"f2b7fbea-6db8-4fa0-8f16-6c7684ada3fa","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Get Access Token - M2M Apps","item":[{"name":"Get Access Token - Client Credentials Grant","event":[{"listen":"test","script":{"id":"ac7f9a4c-3d98-4004-a573-ff5ae1f2eeb1","exec":[""],"type":"text/javascript"}}],"id":"8608a1d1-2c34-4c4c-b880-e8d5291f50e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{m2mSecret}}","username":"{{m2mClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{m2mScopes}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

Requires a Client ID and Client Secret for the service app. This call sets up a base64-encoded value for the service app via Basic Auth under authentication, using these values.

\n

Returns the following tokens specific to the service app:

\n
    \n
  • access_token
    • \n
\n

You'll need this token for other REST calls for the service app.

\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"b8db1601-59fe-4140-bd40-c639ff17146e","name":"Get Access Token - Client Credentials Grant","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{m2mScopes}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1516"},{"key":"Date","value":"Wed, 31 Jul 2019 22:23:37 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIyOTllNGMyOGJmMTZmMmQ5ZDg3NDEzYTJhMmQwN2I2YiIsImN0cyI6Ik9BVVRIMl9TVEFURUxFU1NfR1JBTlQiLCJhdWRpdFRyYWNraW5nSWQiOiIwZWIyODEzMC1jN2VkLTQwNWMtYTNmMy0yMGFiYmVkNzQ2ZGMtMjMwOTgiLCJpc3MiOiJodHRwczovL29wZW5hbS1zcGFyazA3MzAuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImFjY2Vzc190b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6IkJhd0ZzSkZCcEtGS2o0RXVCVi0xRjhxbVZabyIsImF1ZCI6IjI5OWU0YzI4YmYxNmYyZDlkODc0MTNhMmEyZDA3YjZiIiwibmJmIjoxNTY0NjExODE3LCJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsidXNlci51cGRhdGUiLCJhcHAucmVhZCIsInVzZXIucmVjb3Zlci11c2VybmFtZSIsInVzZXIucmVhZCIsInVzZXIuY3JlYXRlIiwicGFzc3dvcmQtcG9saWN5LnJlYWQiLCJlbWFpbC10ZW1wbGF0ZS5yZWFkIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQ2MTE4MTcsInJlYWxtIjoiLyIsImV4cCI6MTU2NDYxNTQxNywiaWF0IjoxNTY0NjExODE3LCJleHBpcmVzX2luIjozNjAwLCJqdGkiOiJyWkU2dXRNWWhyQVBwdHJWYzRjMFNtbVE4bXcifQ.IW1eJzmZsUEafiCPMfoJpvcssBgvcez8UlMA4BzRG5eiBlclTu2Wli5lG8mZtq3of44s666YIxmAF6Oad8fCSaLwMngtFi42sz1dK_TU6soxQfTUQLjuP_8ysy981WV2JZELA6rC2SfU5VcgShwgLfF8PegP4SdcT_I53NO5uZOJxKDXAXT-Pr8vVWeRu3NKfOFSH3-5f-0L2pzZJPB7Tw5MbGmDDerRAiSIkLO3H1JuI9X2yqapRpeyaKl-IjeuSR8xbk1n_jQt-ixcF5Gh2cBqbcA-QdMF-5-WmWud1iRzzmQSMNquGOEu1nQeMEBgPKgidiJN-PLWFe3WbjbfSA\",\n \"scope\": \"user.update app.read user.recover-username user.read user.create password-policy.read email-template.read user.reset-password\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"8608a1d1-2c34-4c4c-b880-e8d5291f50e9"},{"name":"Get Access Token - QuickStart Default Express App","event":[{"listen":"test","script":{"id":"ac7f9a4c-3d98-4004-a573-ff5ae1f2eeb1","exec":[""],"type":"text/javascript"}}],"id":"0475efd6-5e10-4330-9b0d-0fa24e0b4b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{defaultAppSecret}}","username":"{{defaultAppClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{defaultAppScopes}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

Gets an access token for the using Client ID and Client Secret for the Default Expess App.

\n

We'll use the the access_token returned by this call to access our Managememt APIs

\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"0062f24c-657d-4133-949a-c56790909f8a","name":"Get Access Token - QuickStart Default Express App","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{defaultAppScopes}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1913"},{"key":"Date","value":"Wed, 31 Jul 2019 20:38:05 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIwNmFkZGJhMzM4MmE2NWU5NDg0YWNlYmE1NjlmOTYxMiIsImN0cyI6Ik9BVVRIMl9TVEFURUxFU1NfR1JBTlQiLCJhdWRpdFRyYWNraW5nSWQiOiIwZWIyODEzMC1jN2VkLTQwNWMtYTNmMy0yMGFiYmVkNzQ2ZGMtMTk2MzYiLCJpc3MiOiJodHRwczovL29wZW5hbS1zcGFyazA3MzAuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImFjY2Vzc190b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6IlNkcjhKUXZMTWRxNjMwSFUzWjFxeUZrT3k4TSIsImF1ZCI6IjA2YWRkYmEzMzgyYTY1ZTk0ODRhY2ViYTU2OWY5NjEyIiwibmJmIjoxNTY0NjA1NDg1LCJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsidXNlci5kZWxldGUiLCJ1c2VyLnVwZGF0ZSIsImFwcC5jcmVhdGUiLCJlbWFpbC10ZW1wbGF0ZS51cGRhdGUiLCJhcHAucmVhZCIsInVzZXIucmVjb3Zlci11c2VybmFtZSIsImFwcC51cGRhdGUiLCJ1c2VyLnJlYWQiLCJ1c2VyLmNyZWF0ZSIsInBhc3N3b3JkLXBvbGljeS5yZWFkIiwiYXBwLmRlbGV0ZSIsImhvc3RlZC1wYWdlLWNvbmZpZy5yZWFkIiwicGFzc3dvcmQtcG9saWN5LnVwZGF0ZSIsImVtYWlsLXRlbXBsYXRlLnJlYWQiLCJob3N0ZWQtcGFnZS1jb25maWcudXBkYXRlIiwiYXBwLnJlZnJlc2gtc2VjcmV0IiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQ2MDU0ODUsInJlYWxtIjoiLyIsImV4cCI6MTU2NDY0MTQ4NSwiaWF0IjoxNTY0NjA1NDg1LCJleHBpcmVzX2luIjozNjAwMCwianRpIjoiWGxkOC1ZRW1lYWYwSHNOR25GQlotYlZyVkdrIn0.UbTI1EU_d13cpVFWrxH7ZIJrhrioMkemtxZRABOmc5he82F0y0WoOIworDnN9xp9U3Q_0ZbzRYi1VLdXHDHEyOhAg8fjCVe6WzEyN_mCt_gVPinYwacbKZlqVABY_pxyBzJt7itpgc9-AuXI6tNDyfGEDh9tuJ8xbOc7G70IVxUE5JuRTsxBX8QhTVIdbUGLz-gG8uSWdrz72wnbw0XUdhBu3IWhbE3kd0Yxa1fnUL-unOIAg5VKs9QKlgDf9Zminrt1Rb-Mq_W_7q5qWn1cN7anTKJ2QNN3Bd3b3me5FsN2VwHY-b9JzROjH2fqTg-RsHqMuzw4YCAJ5Ax5JIHRoA\",\n \"scope\": \"user.delete user.update app.create email-template.update app.read user.recover-username app.update user.read user.create password-policy.read app.delete hosted-page-config.read password-policy.update email-template.read hosted-page-config.update app.refresh-secret user.reset-password\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 35999\n}"}],"_postman_id":"0475efd6-5e10-4330-9b0d-0fa24e0b4b45"}],"id":"b40e7e38-2189-4ae5-a527-be5c821fba42","description":"

Using the clientId and clientSecret you can get an access token intended for one machine to access another machine to machine.

\n

When an access_token is returned via these APIs, our scripts store them in a variable called accessToken which can be used to access other API calls in our collections.

\n","event":[{"listen":"prerequest","script":{"id":"a8430055-c7b2-4532-94dd-222c6f819613","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d13e0df-9833-4645-a9f8-3fc97dde5069","type":"text/javascript","exec":["var json = JSON.parse(responseBody);","","if (json.access_token) { "," pm.environment.set(\"accessToken\",json.access_token);"," console.log(`set accessToken: ${json.access_token}`);"," console.log(`scope is: ${json.scope}`);","}","",""]}}],"_postman_id":"b40e7e38-2189-4ae5-a527-be5c821fba42","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Get Access Token - Password Grant","item":[{"name":"Access Token Mgmt","item":[{"name":"Tokeninfo","id":"3b0aee0a-5733-4fb9-9f73-59c4955bb6d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{oauth2Url}}/tokeninfo?access_token={{accessToken}}","description":"

Validates a user ID token for debugging. Requires an access_token created for the specific user, set as the Bearer token. You can acquire a user access_token from the Get Web App Token - Password Grant REST call.

\n","urlObject":{"path":["tokeninfo"],"host":["{{oauth2Url}}"],"query":[{"key":"access_token","value":"{{accessToken}}"}],"variable":[]}},"response":[{"id":"9b55dd21-056d-448a-9d1d-9d499986bdf5","name":"Tokeninfo","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{oauth2Url}}/tokeninfo?access_token={{accessToken}}","host":["{{oauth2Url}}"],"path":["tokeninfo"],"query":[{"key":"access_token","value":"{{accessToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"2273"},{"key":"Date","value":"Mon, 22 Jul 2019 16:18:39 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"sub\": \"bjensen@example.com\",\n \"auth_level\": 0,\n \"auditTrackingId\": \"6128798c-bed3-4399-a3b0-5ca24ee5837d-200656\",\n \"me.update\": \"\",\n \"iss\": \"https://openam-sampletenant.forgeblocks.com/am/oauth2\",\n \"tokenName\": \"access_token\",\n \"token_type\": \"Bearer\",\n \"user.recover-username\": \"\",\n \"user.read\": \"\",\n \"password-policy.read\": \"\",\n \"grant_type\": \"authorization_code\",\n \"scope\": [\n \"openid\",\n \"me.update\",\n \"user.recover-username\",\n \"user.read\",\n \"me.read\",\n \"user.create\",\n \"password-policy.read\",\n \"me.update-password\",\n \"password-policy.update\",\n \"user.reset-password\"\n ],\n \"auth_time\": 1563812252,\n \"me.update-password\": \"\",\n \"password-policy.update\": \"\",\n \"exp\": 1563815874,\n \"iat\": 1563812274,\n \"expires_in\": 3600,\n \"jti\": \"CZFUQbiKw7zsowgYEkucB48Sgc0\",\n \"cts\": \"OAUTH2_STATELESS_GRANT\",\n \"openid\": \"\",\n \"authGrantId\": \"JvvemYNSx71kXg7gamnIzD8750c\",\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjYxMjg3OThjLWJlZDMtNDM5OS1hM2IwLTVjYTI0ZWU1ODM3ZC0yMDA2NTYiLCJpc3MiOiJodHRwczovL29wZW5hbS1rYXRlMDcxMHMuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImFjY2Vzc190b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6Ikp2dmVtWU5TeDcxa1hnN2dhbW5JekQ4NzUwYyIsImF1ZCI6IjJmZjViMDdiNTNhNzM2OWIwYjU3OTUyYjJiYjhhMTQ0IiwibmJmIjoxNTYzODEyMjc0LCJncmFudF90eXBlIjoiYXV0aG9yaXphdGlvbl9jb2RlIiwic2NvcGUiOlsib3BlbmlkIiwibWUudXBkYXRlIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZWFkIiwibWUucmVhZCIsInVzZXIuY3JlYXRlIiwicGFzc3dvcmQtcG9saWN5LnJlYWQiLCJtZS51cGRhdGUtcGFzc3dvcmQiLCJwYXNzd29yZC1wb2xpY3kudXBkYXRlIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjM4MTIyNTIsInJlYWxtIjoiLyIsImV4cCI6MTU2MzgxNTg3NCwiaWF0IjoxNTYzODEyMjc0LCJleHBpcmVzX2luIjozNjAwLCJqdGkiOiJDWkZVUWJpS3c3enNvd2dZRWt1Y0I0OFNnYzAifQ.dDiuqMmieO7VSX4QOYG0EBzzkhh2YXpAtC8wuhBGtnjcNTrov-5qOpI8fHAW0binovh_gi3CqlYcEm2tjSYb2Z6Iq3g-rj5HxZsYXDsIhEtfs0j8sC_DlgU3dkqxTL2jJFVLjrtgU2oT2AQmlxIpTYDMlNe5UdQ4nkf1vhZtsAL0Wi2BOpbr-4Y4FzcWxeWIp9Lrjvh1Hu7WU1dm1zMRQMdlKvMtcJPm-pWoMiyFkPJE7O-S9geoJMZVUAUPbT08BTZgycgh_sga8vPQDinnq2P30wCPPhXUpq1zHOvRqGMK1rznqyllew6YG3Mw4E8AMYp-Ic_OV2zT8JYD0Yty1g\",\n \"aud\": \"2ff5b07b53a7369b0b57952b2bb8a144\",\n \"me.read\": \"\",\n \"user.create\": \"\",\n \"nbf\": 1563812274,\n \"realm\": \"/\",\n \"user.reset-password\": \"\"\n}"}],"_postman_id":"3b0aee0a-5733-4fb9-9f73-59c4955bb6d5"},{"name":"Introspect","id":"d9140215-ee48-4377-9cd3-5ad20052e69a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{webSecret}}","username":"{{webClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":""},"url":"{{oauth2Url}}/introspect?token={{accessToken}}","description":"

Returns the content of an access token, including scopes. Requires the Client ID and Client Secret for an existing web app.

\n","urlObject":{"path":["introspect"],"host":["{{oauth2Url}}"],"query":[{"key":"token","value":"{{accessToken}}"}],"variable":[]}},"response":[{"id":"9d04a826-240d-47b4-a91f-53cda81c2c82","name":"Introspect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{oauth2Url}}/introspect?token={{accessToken}}","host":["{{oauth2Url}}"],"path":["introspect"],"query":[{"key":"token","value":"{{accessToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"510"},{"key":"Date","value":"Mon, 22 Jul 2019 16:19:24 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"active\": true,\n \"scope\": \"user.read me.read user.create password-policy.read openid me.update me.update-password password-policy.update user.recover-username user.reset-password\",\n \"client_id\": \"2ff5b07b53a7369b0b57952b2bb8a144\",\n \"user_id\": \"bjensen@example.com\",\n \"token_type\": \"Bearer\",\n \"exp\": 1563815874,\n \"sub\": \"bjensen@example.com\",\n \"iss\": \"https://openam-sampletenant.forgeblocks.com/am/oauth2\",\n \"auth_level\": 0,\n \"auditTrackingId\": \"6128798c-bed3-4399-a3b0-5ca24ee5837d-200656\",\n \"cts\": \"OAUTH2_STATELESS_GRANT\",\n \"expires_in\": 3600\n}"}],"_postman_id":"d9140215-ee48-4377-9cd3-5ad20052e69a"},{"name":"Get Refresh Token","event":[{"listen":"test","script":{"id":"87002a5c-5df5-42a2-ac89-6a717f7a3c16","exec":["var json = JSON.parse(responseBody);","","if (json.access_token) { "," pm.environment.set(\"accessToken\",json.access_token);"," console.log(`set accessToken: ${json.access_token}`);"," console.log(`scope is: ${json.scope}`);","}","","if (json.id_token) { "," pm.environment.set(\"idToken\",json.id_token);"," console.log(`set idToken: ${json.id_token}`);","}","","if (json.refresh_token) { "," pm.environment.set(\"refreshToken\",json.refresh_token);"," console.log(`set refreshToken: ${json.refresh_token}`);","}"],"type":"text/javascript"}}],"id":"dd36c9f0-a8fa-41d7-9d0b-2803a8b43fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{webSecret}}","username":"{{webClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"{{refreshToken}}","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

A refresh_token can be used to obtain a new access_token. The new access_token may include the same or a more narrow set of scopes.

\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"40b57660-f272-406e-9522-efaa8b502c18","name":"Get Refresh Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"{{refreshToken}}","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"4430"},{"key":"Date","value":"Thu, 25 Jul 2019 22:10:58 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjYxMjg3OThjLWJlZDMtNDM5OS1hM2IwLTVjYTI0ZWU1ODM3ZC0yNjA3MTMiLCJpc3MiOiJodHRwczovL29wZW5hbS1rYXRlMDcxMHMuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6ImFjY2Vzc190b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6IkNEbkctN0VxdjA0NlAtelpBNVVxVUdTQ3YtSSIsImF1ZCI6IjM0M2MxYjA5MDE1YmUwNjEyNDlmNDU1Yzc2NWIwYWVmIiwibmJmIjoxNTY0MDkyNjU4LCJncmFudF90eXBlIjoicmVmcmVzaF90b2tlbiIsInNjb3BlIjpbInVzZXIucmVhZCIsIm1lLnJlYWQiLCJ1c2VyLmNyZWF0ZSIsInBhc3N3b3JkLXBvbGljeS5yZWFkIiwib3BlbmlkIiwibWUudXBkYXRlIiwicHJvZmlsZSIsIm1lLnVwZGF0ZS1wYXNzd29yZCIsImVtYWlsIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQwOTI0NDgsInJlYWxtIjoiLyIsImV4cCI6MTU2NDA5NjI1OCwiaWF0IjoxNTY0MDkyNjU4LCJleHBpcmVzX2luIjozNjAwLCJqdGkiOiJfMlZWV3FaZEtvbmZ4VzB1YXZ6WC1VYjNvckkifQ.EZU_DptkyiYGpYEk8pkb6Z520b4zSeIxQGyqLawiQySqO7vgRSruW04BiBdYQt050cMYDOtaw2Pk2OYKMvQ5FjH6fO1JNF9FklF9Mb58mgZTX3dXynW0QeyzWngNOGSdfYZkdNG9LB-v3pCsY74bKk4tDUeBM-9daL_3dbEPxsR995WE6hgTtW_g_incdBP2lQyMvXzFqyY28VD4QXH3RYlJWbdit_vaPF4NCKRZY2xbP-GiAeQgLZKt_HKUOD1OIsKccAs2bArHJwkkVAxsoJKzn0pO9JOhHh3BIJOSuzBfIBDFdQo3jvS0dmxdJSQ8K47M5ddtmVEwJ8IgtacgiQ\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjYxMjg3OThjLWJlZDMtNDM5OS1hM2IwLTVjYTI0ZWU1ODM3ZC0yNjA3MTIiLCJpc3MiOiJodHRwczovL29wZW5hbS1rYXRlMDcxMHMuZm9yZ2VibG9ja3MuY29tL2FtL29hdXRoMiIsInRva2VuTmFtZSI6InJlZnJlc2hfdG9rZW4iLCJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiYXV0aEdyYW50SWQiOiJDRG5HLTdFcXYwNDZQLXpaQTVVcVVHU0N2LUkiLCJhdWQiOiIzNDNjMWIwOTAxNWJlMDYxMjQ5ZjQ1NWM3NjViMGFlZiIsImFjciI6IjAiLCJuYmYiOjE1NjQwOTI2NTgsIm9wcyI6Imw1Wlcydzc1OUJNcW5CaHRXcTVzT1NSdjlpTSIsImdyYW50X3R5cGUiOiJyZWZyZXNoX3Rva2VuIiwic2NvcGUiOlsidXNlci5yZWFkIiwibWUucmVhZCIsInVzZXIuY3JlYXRlIiwicGFzc3dvcmQtcG9saWN5LnJlYWQiLCJvcGVuaWQiLCJtZS51cGRhdGUiLCJwcm9maWxlIiwibWUudXBkYXRlLXBhc3N3b3JkIiwiZW1haWwiLCJ1c2VyLnJlY292ZXItdXNlcm5hbWUiLCJ1c2VyLnJlc2V0LXBhc3N3b3JkIl0sImF1dGhfdGltZSI6MTU2NDA5MjQ0OCwicmVhbG0iOiIvIiwiZXhwIjoxNTY0Njk3NDU4LCJpYXQiOjE1NjQwOTI2NTgsImV4cGlyZXNfaW4iOjYwNDgwMCwianRpIjoiMzdWX2dQUFBueVBPbXkxOVlLcnpDaU1wWHNBIn0.Ii5sLuPXee9Wa4Xasklquk8iYStQTHh-ogHzbvi3oy3z3Z7aZO_nxtKLfOgCbuLogfrluRs2APLbV5WyWx8Ik-wQmW6KnpT5YPbGBbzxWdzBQBYh67gGE6cs-QUHAEorplq0ZCwNRAqhYQ0tFeh4ZQXJAmDx_zLO7Kcq99VNHYkziGpyxxLJEjPqfP8o3Tm-W859H8YxvRpDGw_tOJz4_nhEIoKu0da6OwfYzZoK8fvb_sJZUrR8UlWJ2sa77jK1XdBCYqilfu2xPqkgI2Rf632nkUSU-UjiyeqVpCkGwsES_yah22-EMQBK2gFQSDDFdG1AJvuV5GkNSRHJh-UMJg\",\n \"scope\": \"user.read me.read user.create password-policy.read openid me.update profile me.update-password email user.recover-username user.reset-password\",\n \"id_token\": \"eyJ0eXAiOiJKV1QiLCJraWQiOiJ3VTNpZklJYUxPVUFSZVJCL0ZHNmVNMVAxUU09IiwiYWxnIjoiUlMyNTYifQ.eyJhdF9oYXNoIjoiY3JrMGVLaW9hcDdTamxyMHp6OS0zZyIsInN1YiI6ImJqZW5zZW5AZXhhbXBsZS5jb20iLCJ6b25laW5mbyI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJhdWRpdFRyYWNraW5nSWQiOiI2MTI4Nzk4Yy1iZWQzLTQzOTktYTNiMC01Y2EyNGVlNTgzN2QtMjYwNzE0IiwiaXNzIjoiaHR0cHM6Ly9vcGVuYW0ta2F0ZTA3MTBzLmZvcmdlYmxvY2tzLmNvbS9hbS9vYXV0aDIiLCJ0b2tlbk5hbWUiOiJpZF90b2tlbiIsImxvY2FsZSI6ImVuLVVTIiwidGl0bGUiOiJNYXN0ZXIgQ2FycGVudGVyIiwiYWNyIjoiMCIsImF6cCI6IjM0M2MxYjA5MDE1YmUwNjEyNDlmNDU1Yzc2NWIwYWVmIiwiYXV0aF90aW1lIjoxNTY0MDkyNDQ4LCJuaWNrbmFtZSI6IkJhYnMiLCJleHAiOjE1NjQwOTYyNTgsImlhdCI6MTU2NDA5MjY1OCwiZW1haWwiOiJiYWJzQGplbnNlbi5vcmciLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByb2ZpbGUiOiJodHRwczovL2xvZ2luLmV4YW1wbGUuY29tL2JqZW5zZW4iLCJnaXZlbl9uYW1lIjoiQmFyYmFyYSIsIm1pZGRsZV9uYW1lIjoiSmFuZSIsImF1ZCI6IjM0M2MxYjA5MDE1YmUwNjEyNDlmNDU1Yzc2NWIwYWVmIiwib3JnLmZvcmdlcm9jay5vcGVuaWRjb25uZWN0Lm9wcyI6Imw1Wlcydzc1OUJNcW5CaHRXcTVzT1NSdjlpTSIsIm5hbWUiOiJCYXJiYXJhIEphbmUgSmVuc2VuIiwicmVhbG0iOiIvIiwidG9rZW5UeXBlIjoiSldUVG9rZW4iLCJmYW1pbHlfbmFtZSI6IkplbnNlbiJ9.X2DjSSI32WWNd_TLGtJIzYYCSHGePoYtehOz5rUbagCw6EzsQymWBNkLnKNQZOLH09hcLt8-mTkOndKubw-LUJhzrERqUw_Boro5DxRV2rCzX0L_oLBGm5IoQ-m3gfKIEhNIBDQlXZaRyh7tab56wSGX7byh4t39QK3YjOs49HJxkm-A8mM3y70q0vzix1gkOARzz4aDVROlPVAc9CAIFii-cZbNyw9oi4tSU59S2V9ZjvcWhEVgcPHbQcc9dtpRy5j78vveGahkrpWyQcK-LZKP4LFlIYN2wy6qF4pD9iAeXWn57_goBVxZ-VKt-BSTEqBk7VIwrm6zY3HCZj5Dew\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"dd36c9f0-a8fa-41d7-9d0b-2803a8b43fce"},{"name":"Revoke","id":"5f5de65c-3627-40c3-87a7-a3d08eece75a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"{{accessToken}}","type":"text"},{"key":"client_id","value":"{{webClientId}}","type":"text"},{"key":"client_secret","value":"{{webSecret}}","type":"text"}]},"url":"{{oauth2Url}}/token/revoke","description":"

Revoke an access_token for an app. Requires an access_token created for the app, set as the Bearer token. You can acquire an app access_token from the Get Web App Token - Auth Code Grant REST call.

\n","urlObject":{"path":["token","revoke"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"be4a086b-dc21-438f-b057-f9fecb2e8a90","name":"Revoke","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"{{accessToken}}","type":"text"},{"key":"client_id","value":"{{webClientId}}","type":"text"},{"key":"client_secret","value":"{{webSecret}}","type":"text"}]},"url":"{{oauth2Url}}/token/revoke"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1464"},{"key":"Date","value":"Wed, 07 Aug 2019 13:32:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"error_description\": \"The provided token id : eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6ImFkZTZiMmI2LTZkN2EtNGRlMi05N2RkLTliMGE1NGQzZTNkNi04NTUzNCIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXBlYmJsZS1iYW5rLmZvcmdlYmxvY2tzLmNvbS9hbS9vYXV0aDIiLCJ0b2tlbk5hbWUiOiJhY2Nlc3NfdG9rZW4iLCJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiYXV0aEdyYW50SWQiOiJpa2tPcGNlV3lQMS1fNW9PNXFlbDJuSnZqdnciLCJhdWQiOiJmMzcyYzRlNmQwZjI4MmM3ZTY2MDAxOGVlZjBjMjI3NSIsIm5iZiI6MTU2NTE4NDcyMCwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbInVzZXIucmVhZCIsIm1lLnJlYWQiLCJ1c2VyLmNyZWF0ZSIsInBhc3N3b3JkLXBvbGljeS5yZWFkIiwib3BlbmlkIiwibWUudXBkYXRlIiwicHJvZmlsZSIsIm1lLnVwZGF0ZS1wYXNzd29yZCIsImVtYWlsIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjUxODQ1OTMsInJlYWxtIjoiLyIsImV4cCI6MTU2NTE4ODMyMCwiaWF0IjoxNTY1MTg0NzIwLCJleHBpcmVzX2luIjozNjAwLCJqdGkiOiJfUW54UmtRWVZ3ckdqVzhwT3FLNlFoR2tPeU0ifQ.gWhK73vM0EcD2CvpvT81XfHXwFcvc6okkEn465LEnS5Mml9p_jC3Re1OAvI4OHFY5DZQuh7IzO7sgsOXLmHX1gyA0VZPWyfLPBrV1wWintFgC_qKluMLhANQnq9WvkUA0i7-cV4SDp_72ZrewfUTNDQvekWO0bqx7L0V2VBqH-PowUVrzMLWHwmOA9qV4O_NuxdiANDFlZY7-tYIDI3PCHx34WzdMlxtzPFJ3EAVwT-_oy1slO6UEcBk36cxvA52iNsNpDbNKexFH-kd36JSwG1TbvZGtwmjZnuZGjNrQyAyA7xpnpiKUBh83T7nvfCfOwzl470bDKjc6hnb437y2Q belongs to different access grant.\",\n \"error\": \"invalid_grant\"\n}"}],"_postman_id":"5f5de65c-3627-40c3-87a7-a3d08eece75a"}],"id":"f6907d5a-6a09-4a51-a279-f0169d02887a","description":"

APIs to manage your access tokens

\n","event":[{"listen":"prerequest","script":{"id":"61d36b4d-360f-4471-901c-1cdeeae082e8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a196286-2c52-4131-865b-a488590fccc6","type":"text/javascript","exec":[""]}}],"_postman_id":"f6907d5a-6a09-4a51-a279-f0169d02887a","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"Get Web App Token - Password Grant","event":[{"listen":"test","script":{"id":"f298b48d-fb9c-4c0a-a0c5-cc77ffd1a7dc","exec":["var json = JSON.parse(responseBody);","","if (json.access_token) { "," pm.environment.set(\"accessToken\",json.access_token);"," console.log(`set accessToken: ${json.access_token}`);"," console.log(`scope is: ${json.scope}`);","}","","if (json.id_token) { "," pm.environment.set(\"idToken\",json.id_token);"," console.log(`set idToken: ${json.id_token}`);","}","","if (json.refresh_token) { "," pm.environment.set(\"refreshToken\",json.refresh_token);"," console.log(`set refreshToken: ${json.refresh_token}`);","}"],"type":"text/javascript"}}],"id":"ebf26301-8b5b-493b-babe-0f1b1a88cd28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{webSecret}}","username":"{{webClientId}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","description":"

As allowed by your web app

\n","type":"text"},{"key":"username","value":"{{userName}}","type":"text"},{"key":"password","value":"{{userPassword}}","type":"text"},{"key":"scope","value":"{{webScopes}}","description":"

As defined for your app. Note: include a space (not a comma) between each scope.

\n","type":"text"}]},"url":"{{oauth2Url}}/access_token","description":"

Requires credentials for an existing user, based on a web app. This call sets up a base64-encoded value for the web app via Basic Auth under authentication, using the Client ID and Client Secret for the web app.

\n

Note: This REST call requires manual configuration of the Password grant type for the subject web app. If you've set up a different user and password, adjust the REST call accordingly.

\n

Returns tokens specific to a user:

\n
    \n
  • access_token
    • \n
  • refresh_token
    • \n
  • id_token
    • \n
\n

Prerequisite: You can run this REST call after running the following calls:

\n
    \n
  • Create a New Web App
    • \n
  • Create User
    • \n
\n

The output from these calls automatically populates the variables needed here. You can also substitute the variables of your choice.

\n

If you modify scopes, make sure they correspond to active scopes for your app.

\n","urlObject":{"path":["access_token"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"aaf437f0-3afd-4fc8-bee2-b55e95c6090a","name":"Get Web App Token - Password Grant","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","description":"As allowed by your web app","type":"text"},{"key":"username","value":"{{userName}}","type":"text"},{"key":"password","value":"{{userPassword}}","type":"text"},{"key":"scope","value":"{{webScopes}}","description":"As defined for your app. *Note*: include a space (not a comma) between each scope.","type":"text"}]},"url":"{{oauth2Url}}/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"4232"},{"key":"Date","value":"Wed, 31 Jul 2019 22:22:50 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMjkyNCIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoiYWNjZXNzX3Rva2VuIiwidG9rZW5fdHlwZSI6IkJlYXJlciIsImF1dGhHcmFudElkIjoicXhzQU5XcVN2TlpieWVlVkk1WUtubFJrU3NvIiwiYXVkIjoiYzI2N2Q1ZWIyMDA2NzI5YTIxZjc0ZGRiMzc2NTU5ODYiLCJuYmYiOjE1NjQ2MTE3NzEsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInNjb3BlIjpbIm9wZW5pZCIsIm1lLnVwZGF0ZSIsInByb2ZpbGUiLCJ1c2VyLnJlY292ZXItdXNlcm5hbWUiLCJ1c2VyLnJlYWQiLCJtZS5yZWFkIiwidXNlci5jcmVhdGUiLCJwYXNzd29yZC1wb2xpY3kucmVhZCIsIm1lLnVwZGF0ZS1wYXNzd29yZCIsImVtYWlsIiwidXNlci5yZXNldC1wYXNzd29yZCJdLCJhdXRoX3RpbWUiOjE1NjQ2MTE3NzEsInJlYWxtIjoiLyIsImV4cCI6MTU2NDYxNTM3MSwiaWF0IjoxNTY0NjExNzcxLCJleHBpcmVzX2luIjozNjAwLCJqdGkiOiJ0aWNxZGFINnJmNFBHbnVqbWd5cExMbVN2c3MifQ.Mvc7IZqA35dEFx-3lTzCJl6XSwO4qeyc0fD8S50MO19o0E7xXNW5TJpgeeIj_M7L7eCQxGbdMn1lpr-XV-QOl3S7lC9pjZEOCbEnwXQaDE7URB_V0GheCx62DzrgkANt_0fVQS3OoM5PqK5thr5Pw3ncBIeylF42d7gZ50pCwQKK9sGQcADZuAj8y0muEDMYzup_bBpO22URnBqeXEAmMvD4O09QonTuAtJSh8KD5Dj1cIcuH7u8IEhHiHuutEPSA9MRLilrZ4STa6rpTUeAc-srUmhEOqva1RgXb25-s13Xb7vTnWA6tXN_CE0_smM2Saih4q2e6ejOPvghk0nj7g\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJ6aXAiOiJOT05FIiwia2lkIjoid1UzaWZJSWFMT1VBUmVSQi9GRzZlTTFQMVFNPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJiamVuc2VuQGV4YW1wbGUuY29tIiwiY3RzIjoiT0FVVEgyX1NUQVRFTEVTU19HUkFOVCIsImF1dGhfbGV2ZWwiOjAsImF1ZGl0VHJhY2tpbmdJZCI6IjBlYjI4MTMwLWM3ZWQtNDA1Yy1hM2YzLTIwYWJiZWQ3NDZkYy0yMjkyMyIsImlzcyI6Imh0dHBzOi8vb3BlbmFtLXNwYXJrMDczMC5mb3JnZWJsb2Nrcy5jb20vYW0vb2F1dGgyIiwidG9rZW5OYW1lIjoicmVmcmVzaF90b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJhdXRoR3JhbnRJZCI6InF4c0FOV3FTdk5aYnllZVZJNVlLbmxSa1NzbyIsImF1ZCI6ImMyNjdkNWViMjAwNjcyOWEyMWY3NGRkYjM3NjU1OTg2IiwibmJmIjoxNTY0NjExNzcxLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJzY29wZSI6WyJvcGVuaWQiLCJtZS51cGRhdGUiLCJwcm9maWxlIiwidXNlci5yZWNvdmVyLXVzZXJuYW1lIiwidXNlci5yZWFkIiwibWUucmVhZCIsInVzZXIuY3JlYXRlIiwicGFzc3dvcmQtcG9saWN5LnJlYWQiLCJtZS51cGRhdGUtcGFzc3dvcmQiLCJlbWFpbCIsInVzZXIucmVzZXQtcGFzc3dvcmQiXSwiYXV0aF90aW1lIjoxNTY0NjExNzcxLCJyZWFsbSI6Ii8iLCJleHAiOjE1NjUyMTY1NzEsImlhdCI6MTU2NDYxMTc3MSwiZXhwaXJlc19pbiI6NjA0ODAwLCJqdGkiOiJ1V2d4ZW42MGY1QmZLcWtLR3lQdDFqNFFsczQifQ.QGlAlrVbAY_nk10zmJ4999iK1--dhH1nj7fPxNoAx7IvIDp-A1vg-TckHNtvoPr7ZEaeqN2iX4ccbtj4LE4LRpbb772L41exVfJzCqZT5F3AddFXgllLYE66ydoLd0Grslry5N6Pk2IoLnt1jjuysAPJ9m8ACPxuGuoQ3rHktujgaZcRzFDRv98T1GdS4Da6WmgEN-SQ5skKbfARYiTwTmrHG5s9SGQQ5nnoNZjRYv0XZ7SgSKMMx1-5gAcY8QhpFqUQIdhc2Sqq9_4S9-syqggZBO5dadILAf-YcEYhVh1AqDXVYH4xLaLoUCkMN8d8rIOjZK36--Qug0dLYbi67w\",\n \"scope\": \"openid me.update profile user.recover-username user.read me.read user.create password-policy.read me.update-password email user.reset-password\",\n \"id_token\": \"eyJ0eXAiOiJKV1QiLCJraWQiOiJ3VTNpZklJYUxPVUFSZVJCL0ZHNmVNMVAxUU09IiwiYWxnIjoiUlMyNTYifQ.eyJhdF9oYXNoIjoidC1UNlNLU2l5blJIQlktMU9Ucm9uZyIsInN1YiI6ImJqZW5zZW5AZXhhbXBsZS5jb20iLCJ6b25laW5mbyI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJhdWRpdFRyYWNraW5nSWQiOiIwZWIyODEzMC1jN2VkLTQwNWMtYTNmMy0yMGFiYmVkNzQ2ZGMtMjI5MjYiLCJwcm9maWxlIjoiaHR0cHM6Ly9sb2dpbi5leGFtcGxlLmNvbS9iamVuc2VuIiwiaXNzIjoiaHR0cHM6Ly9vcGVuYW0tc3BhcmswNzMwLmZvcmdlYmxvY2tzLmNvbS9hbS9vYXV0aDIiLCJ0b2tlbk5hbWUiOiJpZF90b2tlbiIsImxvY2FsZSI6ImVuLVVTIiwiZ2l2ZW5fbmFtZSI6IkJhcmJhcmEiLCJ0aXRsZSI6Ik1hc3RlciBDYXJwZW50ZXIiLCJhdWQiOiJjMjY3ZDVlYjIwMDY3MjlhMjFmNzRkZGIzNzY1NTk4NiIsInVwZGF0ZWRfYXQiOjE1NjQ2MTE1NTIsImF6cCI6ImMyNjdkNWViMjAwNjcyOWEyMWY3NGRkYjM3NjU1OTg2IiwiYXV0aF90aW1lIjoxNTY0NjExNzcxLCJuYW1lIjoiQmFyYmFyYSBKZW5zZW4iLCJuaWNrbmFtZSI6IkJhYnMiLCJyZWFsbSI6Ii8iLCJleHAiOjE1NjQ2MTUzNzEsInRva2VuVHlwZSI6IkpXVFRva2VuIiwiZmFtaWx5X25hbWUiOiJKZW5zZW4iLCJpYXQiOjE1NjQ2MTE3NzEsImVtYWlsIjoiamFsbGVuQHNwYXJraWRlbnRpdHkuY29tIn0.FsDh7sfm59708MCn29CxhSsX3IAYS0CG3SdxvsMmXqQm19m2xpR2m5ntdxsCAfJZUceg2VtD69_7lNqs1tEmn6M9wDv1DtnDl0oZT1hGnV11DqS0gwuZ1wdr48OpTvUAs-u_MLngcTGSLGqWegiZhAMzM3AbtVYVqc4a_5qloGcx3WaVUiyekRE2JS-AEzVcCuwROsNgQBobphZ7DF0NFjyOVZ4y4T9jF4K23TngwsfDKcWIRXoLmT_Cfxy_BjpB9UGJHJOmEl-Wzefl2gM313V3f6w8RuTuuXkJZaF3I2Nb5zzhsYRQxpKOwmt47kkE2y-UjnTNDIKsHlWN4kp_Ag\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"}],"_postman_id":"ebf26301-8b5b-493b-babe-0f1b1a88cd28"}],"id":"e1f28157-7834-42ad-90e6-e4c030f2ad58","description":"

We recommend using this grant type only in early development testing and prototyping in non-production instances. For production purposes rely on our API collections for obtaining access tokens for Web Apps, Native/Spa Apps, and M2M Apps.

\n","event":[{"listen":"prerequest","script":{"id":"f0e7b75b-2b39-4b7f-8d49-7d5fd8aaa582","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e3c180a-83bd-44ff-bdc2-a0b7588af66f","type":"text/javascript","exec":[""]}}],"_postman_id":"e1f28157-7834-42ad-90e6-e4c030f2ad58","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}},{"name":"ID Token Mgmt","item":[{"name":"UserInfo","id":"1b6f24c4-bef8-4be9-881b-1c8518213a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{oauth2Url}}/userinfo","description":"

Returns end user info. Requires an access_token created for the specific user, set as the Bearer token. You can acquire a user access_token from the Get Web App Token - Password Grant REST call.

\n","urlObject":{"path":["userinfo"],"host":["{{oauth2Url}}"],"query":[],"variable":[]}},"response":[{"id":"50428251-29ad-4b59-b307-7dab2f6241b6","name":"UserInfo","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{oauth2Url}}/userinfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"315"},{"key":"Date","value":"Thu, 25 Jul 2019 22:09:28 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"locale\": \"en-US\",\n \"family_name\": \"Jensen\",\n \"given_name\": \"Barbara\",\n \"middle_name\": \"Jane\",\n \"name\": \"Barbara Jane Jensen\",\n \"nickname\": \"Babs\",\n \"profile\": \"https://login.example.com/bjensen\",\n \"title\": \"Master Carpenter\",\n \"zoneinfo\": \"America/Los_Angeles\",\n \"email_verified\": false,\n \"email\": \"babs@jensen.org\",\n \"sub\": \"bjensen@example.com\"\n}"}],"_postman_id":"1b6f24c4-bef8-4be9-881b-1c8518213a88"},{"name":"Check session","id":"69a863a7-90fb-4e37-bfb8-d1a963258021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{oauth2Url}}/connect/checkSession?id_token={{idToken}}","description":"

Check the session state of the user with the id_token. Allows clients to receive notifications. You can get the id_token from the Get Web App Token - Password Grant REST call.

\n

This works with the check_session_iframe URL seen in the GET Discover REST call.

\n","urlObject":{"path":["connect","checkSession"],"host":["{{oauth2Url}}"],"query":[{"key":"id_token","value":"{{idToken}}"}],"variable":[]}},"response":[{"id":"95d20912-9491-4500-8268-5f1ff6e162db","name":"Check session","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{oauth2Url}}/connect/checkSession?id_token={{idToken}}","host":["{{oauth2Url}}"],"path":["connect","checkSession"],"query":[{"key":"id_token","value":"{{idToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"text/html;charset=UTF-8"},{"key":"Content-Length","value":"2078"},{"key":"Date","value":"Thu, 25 Jul 2019 22:09:53 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"\n\n\n \n \n \n OpenIDConnect checkSession\n \n \n \n \n \n"}],"_postman_id":"69a863a7-90fb-4e37-bfb8-d1a963258021"},{"name":"End session","id":"e26cddff-8d60-41e8-8b6a-7acfd4014f5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{oauth2Url}}/connect/endSession?id_token_hint={{idToken}}&post_logout_redirect_uri={{logoutUrl}}","description":"

End the current session. Requires the id_token created for the user, which is set to id_token_hint. You get an id token when you get an access token for a web app, a native spa app, or the password grant and you specify openid as part of the scopes.

\n

This endpoint returns a 302 upon success and redirects to the specified post logout uri.

\n","urlObject":{"path":["connect","endSession"],"host":["{{oauth2Url}}"],"query":[{"key":"id_token_hint","value":"{{idToken}}"},{"key":"post_logout_redirect_uri","value":"{{logoutUrl}}"}],"variable":[]}},"response":[{"id":"8a0fffab-b368-4c36-81f1-9d1c42cd3eb9","name":"End session","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{oauth2Url}}/connect/endSession?id_token_hint={{idToken}}&post_logout_redirect_uri={{logoutUrl}}","host":["{{oauth2Url}}"],"path":["connect","endSession"],"query":[{"key":"id_token_hint","value":"{{idToken}}"},{"key":"post_logout_redirect_uri","value":"{{logoutUrl}}"}]}},"status":"Found","code":302,"_postman_previewlanguage":"plain","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Location","value":"https://example.com/homeLogout/"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 22 Jul 2019 17:02:06 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e26cddff-8d60-41e8-8b6a-7acfd4014f5c"},{"name":"IdTokenInfo","id":"e58e0130-affb-43a9-a034-d2fd9b01d8b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{oauth2Url}}/idtokeninfo?client_id={{webClientId}}&client_secret={{webSecret}}&id_token={{idToken}}","description":"

Returns ID Token information

\n","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}},"urlObject":{"path":["idtokeninfo"],"host":["{{oauth2Url}}"],"query":[{"key":"client_id","value":"{{webClientId}}"},{"key":"client_secret","value":"{{webSecret}}"},{"key":"id_token","value":"{{idToken}}"}],"variable":[]}},"response":[{"id":"f6d7bc64-e791-45f5-b0da-e78d7ed3ca98","name":"IdTokenInfo","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{oauth2Url}}/idtokeninfo?client_id={{webClientId}}&client_secret={{webSecret}}&id_token={{idToken}}","host":["{{oauth2Url}}"],"path":["idtokeninfo"],"query":[{"key":"client_id","value":"{{webClientId}}"},{"key":"client_secret","value":"{{webSecret}}"},{"key":"id_token","value":"{{idToken}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"812"},{"key":"Date","value":"Thu, 25 Jul 2019 22:08:01 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"clear"}],"cookie":[],"responseTime":null,"body":"{\n \"at_hash\": \"2CVus6vvsexrdTfcx3eTOw\",\n \"sub\": \"bjensen@example.com\",\n \"zoneinfo\": \"America/Los_Angeles\",\n \"auditTrackingId\": \"6128798c-bed3-4399-a3b0-5ca24ee5837d-260605\",\n \"iss\": \"https://openam-sampletenant.forgeblocks.com/am/oauth2\",\n \"tokenName\": \"id_token\",\n \"locale\": \"en-US\",\n \"title\": \"Master Carpenter\",\n \"acr\": \"0\",\n \"azp\": \"343c1b09015be061249f455c765b0aef\",\n \"auth_time\": 1564092448,\n \"nickname\": \"Babs\",\n \"exp\": 1564096062,\n \"iat\": 1564092462,\n \"email\": \"babs@jensen.org\",\n \"email_verified\": false,\n \"profile\": \"https://login.example.com/bjensen\",\n \"given_name\": \"Barbara\",\n \"middle_name\": \"Jane\",\n \"aud\": \"343c1b09015be061249f455c765b0aef\",\n \"c_hash\": \"ZuTpBmmnUxQimVcV_O0UJA\",\n \"org.forgerock.openidconnect.ops\": \"l5ZW2w759BMqnBhtWq5sOSRv9iM\",\n \"s_hash\": \"bKE9UspwyIPg8LsQHkJaiQ\",\n \"name\": \"Barbara Jane Jensen\",\n \"realm\": \"/\",\n \"tokenType\": \"JWTToken\",\n \"family_name\": \"Jensen\"\n}"}],"_postman_id":"e58e0130-affb-43a9-a034-d2fd9b01d8b2"}],"id":"16e02e69-9d3e-4211-a86b-138b123107f2","description":"

APIs to manage your ID Tokens

\n","event":[{"listen":"prerequest","script":{"id":"5408a6dc-ae96-4aff-8959-168fe86f1510","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"270993d5-bba1-40f1-aa1b-b2cee2db073d","type":"text/javascript","exec":[""]}}],"_postman_id":"16e02e69-9d3e-4211-a86b-138b123107f2","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}}],"id":"ecb8954a-4d9a-447a-b8e5-0d2ff9ade3db","description":"

Supports authentication of users to access apps. Some Authentication API endpoints support creation of app and user access tokens. You can then use those access tokens in the Management API.

\n

You can use these REST calls to build authentication into your apps.

\n

To take full advantage of the Management API, include appropriate scopes in requests to authorization endpoints. The Authentication API then includes the scope in the output access token. For more information, see our documentation on scopes.

\n","event":[{"listen":"prerequest","script":{"id":"2b0ceab8-13c5-48ca-8092-708651935099","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d3b829d4-6dbe-44d8-9e63-f3643d0e43a5","type":"text/javascript","exec":[""]}}],"_postman_id":"ecb8954a-4d9a-447a-b8e5-0d2ff9ade3db","auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"c0a342ab-034d-42d6-ac8d-d321095aa313","id":"c0a342ab-034d-42d6-ac8d-d321095aa313","name":"Express APIs","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"{{accessToken}}"}},"event":[{"listen":"prerequest","script":{"id":"b757ac0e-2446-44f4-a6c9-2aa987b49616","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef1eff50-076a-4b57-b5a4-61697e40b4b5","type":"text/javascript","exec":[""]}}]}