Chilkat Online Tools

delphiAx / ForgeRock Identity Cloud Collection / Step 3: Resume Suspended Journey using Suspended ID from Email

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_type: WideString;
v_id: Integer;
j: Integer;
count_j: Integer;
name: WideString;
value: WideString;
authId: WideString;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

http.SetRequestHeader('Content-Type','application/json');
http.SetRequestHeader('Accept-API-Version','resource=2.1, protocol=1.0');

resp := http.QuickRequest('POST','https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?suspendedId=suspended_id_from_email');
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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

authId := jResp.StringOf('authId');
i := 0;
count_i := jResp.SizeOfArray('callbacks');
while i < count_i do
  begin
    jResp.I := i;
    v_type := jResp.StringOf('callbacks[i].type');
    v_id := jResp.IntOf('callbacks[i]._id');
    j := 0;
    count_j := jResp.SizeOfArray('callbacks[i].output');
    while j < count_j do
      begin
        jResp.J := j;
        name := jResp.StringOf('callbacks[i].output[j].name');
        value := jResp.StringOf('callbacks[i].output[j].value');
        j := j + 1;
      end;

    j := 0;
    count_j := jResp.SizeOfArray('callbacks[i].input');
    while j < count_j do
      begin
        jResp.J := j;
        name := jResp.StringOf('callbacks[i].input[j].name');
        value := jResp.StringOf('callbacks[i].input[j].value');
        j := j + 1;
      end;

    i := i + 1;
  end;

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": [
          "",
          "",
          "// 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 *Forgotten Username* journey will continue, and the username provided."
  },
  "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}"
    }
  ]
}