Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "authId": "{{authId}}",
# "callbacks": [
# {
# "type": "StringAttributeInputCallback",
# "output": [
# {
# "name": "name",
# "value": "mail"
# },
# {
# "name": "prompt",
# "value": "Email Address"
# },
# {
# "name": "required",
# "value": true
# },
# {
# "name": "policies",
# "value": {}
# },
# {
# "name": "failedPolicies",
# "value": [
# ]
# },
# {
# "name": "validateOnly",
# "value": false
# },
# {
# "name": "value",
# "value": ""
# }
# ],
# "input": [
# {
# "name": "IDToken1",
# "value": "{{postmanDemoEmail}}"
# },
# {
# "name": "IDToken1validateOnly",
# "value": false
# }
# ],
# "_id": 0
# }
# ],
# "header": "Sign Up",
# "description": "Signing up is fast and easy.<br>Already have an account? <a href='#/service/Login'>Sign In</a>"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "authId" "{{authId}}"
CkJsonObject_UpdateString $json "callbacks[0].type" "StringAttributeInputCallback"
CkJsonObject_UpdateString $json "callbacks[0].output[0].name" "name"
CkJsonObject_UpdateString $json "callbacks[0].output[0].value" "mail"
CkJsonObject_UpdateString $json "callbacks[0].output[1].name" "prompt"
CkJsonObject_UpdateString $json "callbacks[0].output[1].value" "Email Address"
CkJsonObject_UpdateString $json "callbacks[0].output[2].name" "required"
CkJsonObject_UpdateBool $json "callbacks[0].output[2].value" 1
CkJsonObject_UpdateString $json "callbacks[0].output[3].name" "policies"
CkJsonObject_UpdateNewObject $json "callbacks[0].output[3].value"
CkJsonObject_UpdateString $json "callbacks[0].output[4].name" "failedPolicies"
CkJsonObject_UpdateNewArray $json "callbacks[0].output[4].value"
CkJsonObject_UpdateString $json "callbacks[0].output[5].name" "validateOnly"
CkJsonObject_UpdateBool $json "callbacks[0].output[5].value" 0
CkJsonObject_UpdateString $json "callbacks[0].output[6].name" "value"
CkJsonObject_UpdateString $json "callbacks[0].output[6].value" ""
CkJsonObject_UpdateString $json "callbacks[0].input[0].name" "IDToken1"
CkJsonObject_UpdateString $json "callbacks[0].input[0].value" "{{postmanDemoEmail}}"
CkJsonObject_UpdateString $json "callbacks[0].input[1].name" "IDToken1validateOnly"
CkJsonObject_UpdateBool $json "callbacks[0].input[1].value" 0
CkJsonObject_UpdateInt $json "callbacks[0]._id" 0
CkJsonObject_UpdateString $json "header" "Sign Up"
CkJsonObject_UpdateString $json "description" "Signing up is fast and easy.<br>Already have an account? <a href='#/service/Login'>Sign In</a>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept-API-Version" "resource=2.0, protocol=1.0"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=ForgottenUsername" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "tokenId": "N60dPV99pcqVVI.*AAJTSQACMDEAAANDVFMAAlMxAAA.*",
# "successUrl": "/openam/console",
# "realm": "/"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set tokenId [CkJsonObject_stringOf $jResp "tokenId"]
set successUrl [CkJsonObject_stringOf $jResp "successUrl"]
set realm [CkJsonObject_stringOf $jResp "realm"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept-API-Version: resource=2.0, protocol=1.0"
-d '{
"authId": "{{authId}}",
"callbacks": [
{
"type": "StringAttributeInputCallback",
"output": [
{
"name": "name",
"value": "mail"
},
{
"name": "prompt",
"value": "Email Address"
},
{
"name": "required",
"value": true
},
{
"name": "policies",
"value": {}
},
{
"name": "failedPolicies",
"value": []
},
{
"name": "validateOnly",
"value": false
},
{
"name": "value",
"value": ""
}
],
"input": [
{
"name": "IDToken1",
"value": "{{postmanDemoEmail}}"
},
{
"name": "IDToken1validateOnly",
"value": false
}
],
"_id": 0
}
],
"header": "Sign Up",
"description": "Signing up is fast and easy.<br>Already have an account? <a href=\'#/service/Login\'>Sign In</a>"
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=ForgottenUsername
Postman Collection Item JSON
{
"name": "Step 2: Handle \"ForgottenUsername\" Journey Callback",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const JSONResponse = JSON.parse(responseBody);",
"",
"// Did request have another callback?",
"if(JSONResponse.authId && JSONResponse.authId != \"\")",
"{",
" // Set `authId` variable",
" pm.globals.set(\"authId\", JSONResponse.authId);",
"}",
"",
"// Did request return SSO Token?",
"if(JSONResponse.tokenId && JSONResponse.tokenId != \"\")",
"{",
" // Set `demoSSOToken` variable",
" pm.globals.set(\"demoSSOToken\", JSONResponse.tokenId);",
"",
" // Remove `authId` variable",
" pm.globals.unset(\"authId\");",
" ",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains tokenId or authId\", function () {",
" pm.expect(JSONResponse).to.have.any.keys('tokenId', 'authId');",
"});",
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableCookies": true
},
"request": {
"method": "POST",
"header": [
{
"description": "Specifies that the `/json/authenticate` endpoint uses JSON format for requests.",
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Specifies the version of the `/json/authenticate` endpoint to use.",
"key": "Accept-API-Version",
"value": "resource=2.0, protocol=1.0"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"StringAttributeInputCallback\",\n \"output\": [\n {\n \"name\": \"name\",\n \"value\": \"mail\"\n },\n {\n \"name\": \"prompt\",\n \"value\": \"Email Address\"\n },\n {\n \"name\": \"required\",\n \"value\": true\n },\n {\n \"name\": \"policies\",\n \"value\": {}\n },\n {\n \"name\": \"failedPolicies\",\n \"value\": []\n },\n {\n \"name\": \"validateOnly\",\n \"value\": false\n },\n {\n \"name\": \"value\",\n \"value\": \"\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{{postmanDemoEmail}}\"\n },\n {\n \"name\": \"IDToken1validateOnly\",\n \"value\": false\n }\n ],\n \"_id\": 0\n }\n ],\n \"header\": \"Sign Up\",\n \"description\": \"Signing up is fast and easy.<br>Already have an account? <a href='#/service/Login'>Sign In</a>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue=ForgottenUsername",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "authIndexType",
"value": "service",
"description": "Allows the request to configure the service (for example, an authentication tree) to use for this request."
},
{
"key": "authIndexValue",
"value": "ForgottenUsername",
"description": "Specifies the name of the service to use for this request.\nOverride this value using the `amAuthenticationTree` Postman variable."
}
]
},
"description": "Respond to the callbacks of the *Forgotten Username* journey, by providing the email address of the relevant user.\n\nThe builtin `ForgottenUsername` journey uses the Suspended Authentication feature, and sends the relevant user an email containing a \"magic link\".\n\nCopy the unique ID from the URL of that magic link, and use it in the next step to obtain the forgotten username."
},
"response": [
{
"name": "Success - authentication complete",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "Specifies that the `/json/authenticate` endpoint uses JSON format for requests."
},
{
"key": "Accept-API-Version",
"value": "resource=2.0, protocol=1.0",
"description": "Specifies the version of the `/json/authenticate` endpoint to use."
}
],
"body": {
"mode": "raw",
"raw": "{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"ChoiceCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Succeed?\"\n },\n {\n \"name\": \"choices\",\n \"value\": [\n \"Yes\",\n \"No\"\n ]\n },\n {\n \"name\": \"defaultChoice\",\n \"value\": 0\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": 0\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue={{loginJourney}}",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "authIndexType",
"value": "service",
"description": "Allows the request to configure the service (for example, an authentication tree) to use for this request."
},
{
"key": "authIndexValue",
"value": "{{loginJourney}}",
"description": "Specifies the name of the service to use for this request.\nOverride this value using the `amAuthenticationTree` Postman variable."
}
]
}
},
"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=N60dPVcmOADQN170-8799pcqVVI.*AAJTSQACMDEAAlNLABw5QThIM0ZJd3RKcmNyWWYxSzlPaGhzcllsUXM9AAR0eXBlAANDVFMAAlMxAAA.*; Path=/; Domain=example.com; HttpOnly"
},
{
"key": "Set-Cookie",
"value": "amlbcookie=01; Path=/; Domain=example.com; HttpOnly"
},
{
"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": "167"
},
{
"key": "Date",
"value": "Wed, 12 Aug 2020 14:10:41 GMT"
}
],
"cookie": [
],
"body": "{\n \"tokenId\": \"N60dPV99pcqVVI.*AAJTSQACMDEAAANDVFMAAlMxAAA.*\",\n \"successUrl\": \"/openam/console\",\n \"realm\": \"/\"\n}"
}
]
}
