PowerBuilder / ForgeRock Identity Cloud Collection / Step 3: Resume Suspended Journey using Suspended ID from Email
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_type
integer li_V_id
integer j
integer li_Count_j
string ls_Name
string ls_Value
string ls_AuthId
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept-API-Version","resource=2.1, protocol=1.0")
loo_Resp = loo_Http.QuickRequest("POST","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?suspendedId=suspended_id_from_email")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "authId": "eyJ0eXAizI1NiJ9...eyJTkNVS-36NdGPz0ldtTxs",
// "callbacks": [
// {
// "type": "NameCallback",
// "output": [
// {
// "name": "prompt",
// "value": "User Name"
// }
// ],
// "input": [
// {
// "name": "IDToken1",
// "value": ""
// }
// ],
// "_id": 0
// },
// {
// "type": "PasswordCallback",
// "output": [
// {
// "name": "prompt",
// "value": "Password"
// }
// ],
// "input": [
// {
// "name": "IDToken2",
// "value": ""
// }
// ],
// "_id": 1
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_AuthId = loo_JResp.StringOf("authId")
i = 0
li_Count_i = loo_JResp.SizeOfArray("callbacks")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("callbacks[i].type")
li_V_id = loo_JResp.IntOf("callbacks[i]._id")
j = 0
li_Count_j = loo_JResp.SizeOfArray("callbacks[i].output")
do while j < li_Count_j
loo_JResp.J = j
ls_Name = loo_JResp.StringOf("callbacks[i].output[j].name")
ls_Value = loo_JResp.StringOf("callbacks[i].output[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("callbacks[i].input")
do while j < li_Count_j
loo_JResp.J = j
ls_Name = loo_JResp.StringOf("callbacks[i].input[j].name")
ls_Value = loo_JResp.StringOf("callbacks[i].input[j].value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept-API-Version: resource=2.1, protocol=1.0"
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?suspendedId=suspended_id_from_email
Postman Collection Item JSON
{
"name": "Step 3: Resume Suspended Journey using Suspended ID from Email",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const JSONResponse = JSON.parse(responseBody);",
"",
"// 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.1, protocol=1.0"
}
],
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?suspendedId=suspended_id_from_email",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "suspendedId",
"value": "suspended_id_from_email",
"description": "Replace `suspended_id_from_email` with the unique code from the email that was sent to the user, if found in the Identity Store."
}
]
},
"description": "Replace `suspended_id_from_email` with the unique code from the email that was sent to the user. \n\nThe *Reset Password* journey will continue, and allow the user to specify a new password, by completing callbacks as usual."
},
"response": [
{
"name": "Success. Callback generated by Username and Password collectors, together in a page node.",
"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."
}
],
"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": "Content-API-Version",
"value": "resource=2.1"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Set-Cookie",
"value": "amlbcookie=01; Path=/; Domain=example.com; HttpOnly"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "2153"
},
{
"key": "Date",
"value": "Wed, 12 Aug 2020 12:01:51 GMT"
}
],
"cookie": [
],
"body": "{\n \"authId\": \"eyJ0eXAizI1NiJ9...eyJTkNVS-36NdGPz0ldtTxs\",\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}"
}
]
}
