Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept-API-Version','resource=2.1, protocol=1.0');
// resp is a CkHttpResponse
$resp = $http->QuickRequest('POST','https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Registration');
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// 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) {
$jResp->put_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) {
$jResp->put_J($j);
$name = $jResp->stringOf('callbacks[i].output[j].name');
$value = $jResp->stringOf('callbacks[i].output[j].value');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('callbacks[i].input');
while ($j < $count_j) {
$jResp->put_J($j);
$name = $jResp->stringOf('callbacks[i].input[j].name');
$value = $jResp->stringOf('callbacks[i].input[j].value');
$j = $j + 1;
}
$i = $i + 1;
}
?>
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?authIndexType=service&authIndexValue=Registration
Postman Collection Item JSON
{
"name": "Step 1: Request \"Registration\" Journey Callback",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const JSONResponse = JSON.parse(responseBody);",
"",
"// Did request have a callback?",
"if(JSONResponse.authId && JSONResponse.authId != \"\")",
"{",
" // Set `authId` variable",
" pm.globals.set(\"authId\", JSONResponse.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"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"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.1, protocol=1.0",
"description": "Specifies the version of the `/json/authenticate` endpoint to use."
}
],
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue=Registration",
"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": "Registration",
"description": "Specifies the name of the service to use for this request.\nOverride this value using the `amAuthenticationTree` Postman variable."
}
]
},
"description": "The first step is to make a POST call to the `/json/authenticate` endpoint, without providing any credentials, or cookies.\n\nThe ForgeRock Identity Cloud provides a *Registration* journey out-of-the-box, which is specified in this request.\n\nEach request that is part of the registration journey uses the same `authId` value to track progress. Ensure the `authId` JWT is sent in each subsequent request, until a session token is issued."
},
"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}"
}
]
}
