Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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": "BooleanAttributeInputCallback",
// "output": [
// {
// "name": "name",
// "value": "preferences/updates"
// },
// {
// "name": "prompt",
// "value": "Send me news and updates"
// },
// {
// "name": "required",
// "value": false
// },
// {
// "name": "policies",
// "value": {}
// },
// {
// "name": "failedPolicies",
// "value": [
// ]
// },
// {
// "name": "validateOnly",
// "value": false
// },
// {
// "name": "value",
// "value": false
// }
// ],
// "input": [
// {
// "name": "IDToken1",
// "value": false
// },
// {
// "name": "IDToken1validateOnly",
// "value": false
// }
// ],
// "_id": 2
// },
// {
// "type": "BooleanAttributeInputCallback",
// "output": [
// {
// "name": "name",
// "value": "preferences/marketing"
// },
// {
// "name": "prompt",
// "value": "Send me special offers and services"
// },
// {
// "name": "required",
// "value": false
// },
// {
// "name": "policies",
// "value": {}
// },
// {
// "name": "failedPolicies",
// "value": [
// ]
// },
// {
// "name": "validateOnly",
// "value": false
// },
// {
// "name": "value",
// "value": false
// }
// ],
// "input": [
// {
// "name": "IDToken2",
// "value": false
// },
// {
// "name": "IDToken2validateOnly",
// "value": false
// }
// ],
// "_id": 3
// }
// ]
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('authId','{{authId}}');
$json->UpdateString('callbacks[0].type','BooleanAttributeInputCallback');
$json->UpdateString('callbacks[0].output[0].name','name');
$json->UpdateString('callbacks[0].output[0].value','preferences/updates');
$json->UpdateString('callbacks[0].output[1].name','prompt');
$json->UpdateString('callbacks[0].output[1].value','Send me news and updates');
$json->UpdateString('callbacks[0].output[2].name','required');
$json->UpdateBool('callbacks[0].output[2].value',0);
$json->UpdateString('callbacks[0].output[3].name','policies');
$json->UpdateNewObject('callbacks[0].output[3].value');
$json->UpdateString('callbacks[0].output[4].name','failedPolicies');
$json->UpdateNewArray('callbacks[0].output[4].value');
$json->UpdateString('callbacks[0].output[5].name','validateOnly');
$json->UpdateBool('callbacks[0].output[5].value',0);
$json->UpdateString('callbacks[0].output[6].name','value');
$json->UpdateBool('callbacks[0].output[6].value',0);
$json->UpdateString('callbacks[0].input[0].name','IDToken1');
$json->UpdateBool('callbacks[0].input[0].value',0);
$json->UpdateString('callbacks[0].input[1].name','IDToken1validateOnly');
$json->UpdateBool('callbacks[0].input[1].value',0);
$json->UpdateInt('callbacks[0]._id',2);
$json->UpdateString('callbacks[1].type','BooleanAttributeInputCallback');
$json->UpdateString('callbacks[1].output[0].name','name');
$json->UpdateString('callbacks[1].output[0].value','preferences/marketing');
$json->UpdateString('callbacks[1].output[1].name','prompt');
$json->UpdateString('callbacks[1].output[1].value','Send me special offers and services');
$json->UpdateString('callbacks[1].output[2].name','required');
$json->UpdateBool('callbacks[1].output[2].value',0);
$json->UpdateString('callbacks[1].output[3].name','policies');
$json->UpdateNewObject('callbacks[1].output[3].value');
$json->UpdateString('callbacks[1].output[4].name','failedPolicies');
$json->UpdateNewArray('callbacks[1].output[4].value');
$json->UpdateString('callbacks[1].output[5].name','validateOnly');
$json->UpdateBool('callbacks[1].output[5].value',0);
$json->UpdateString('callbacks[1].output[6].name','value');
$json->UpdateBool('callbacks[1].output[6].value',0);
$json->UpdateString('callbacks[1].input[0].name','IDToken2');
$json->UpdateBool('callbacks[1].input[0].value',0);
$json->UpdateString('callbacks[1].input[1].name','IDToken2validateOnly');
$json->UpdateBool('callbacks[1].input[1].value',0);
$json->UpdateInt('callbacks[1]._id',3);
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept-API-Version','resource=2.0, protocol=1.0');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->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)
// {
// "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
$tokenId = $jResp->stringOf('tokenId');
$successUrl = $jResp->stringOf('successUrl');
$realm = $jResp->stringOf('realm');
?>
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": "BooleanAttributeInputCallback",
"output": [
{
"name": "name",
"value": "preferences/updates"
},
{
"name": "prompt",
"value": "Send me news and updates"
},
{
"name": "required",
"value": false
},
{
"name": "policies",
"value": {}
},
{
"name": "failedPolicies",
"value": []
},
{
"name": "validateOnly",
"value": false
},
{
"name": "value",
"value": false
}
],
"input": [
{
"name": "IDToken1",
"value": false
},
{
"name": "IDToken1validateOnly",
"value": false
}
],
"_id": 2
},
{
"type": "BooleanAttributeInputCallback",
"output": [
{
"name": "name",
"value": "preferences/marketing"
},
{
"name": "prompt",
"value": "Send me special offers and services"
},
{
"name": "required",
"value": false
},
{
"name": "policies",
"value": {}
},
{
"name": "failedPolicies",
"value": []
},
{
"name": "validateOnly",
"value": false
},
{
"name": "value",
"value": false
}
],
"input": [
{
"name": "IDToken2",
"value": false
},
{
"name": "IDToken2validateOnly",
"value": false
}
],
"_id": 3
}
],
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login
Postman Collection Item JSON
{
"name": "Step 2f: Handle Progressive Profile 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);",
" ",
" // Determine next request based on detected callbacks",
" frUtils.detectCallbacks(responseBody);",
"}",
"",
"// 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\");",
" ",
" // Skip to session info request",
" postman.setNextRequest(\"Step 3: Get Session Info\");",
"}",
"",
"// 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\": \"BooleanAttributeInputCallback\",\n \"output\": [\n {\n \"name\": \"name\",\n \"value\": \"preferences/updates\"\n },\n {\n \"name\": \"prompt\",\n \"value\": \"Send me news and updates\"\n },\n {\n \"name\": \"required\",\n \"value\": false\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\": false\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": false\n },\n {\n \"name\": \"IDToken1validateOnly\",\n \"value\": false\n }\n ],\n \"_id\": 2\n },\n {\n \"type\": \"BooleanAttributeInputCallback\",\n \"output\": [\n {\n \"name\": \"name\",\n \"value\": \"preferences/marketing\"\n },\n {\n \"name\": \"prompt\",\n \"value\": \"Send me special offers and services\"\n },\n {\n \"name\": \"required\",\n \"value\": false\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\": false\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": false\n },\n {\n \"name\": \"IDToken2validateOnly\",\n \"value\": false\n }\n ],\n \"_id\": 3\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."
}
]
},
"description": "To respond to a callback, send back the whole JSON object with the missing `input` values filled.\n\nThis request shows how to respond to `BooleanAttributeInputCallback` callbacks used by the *Progressive Profiling* nodes."
},
"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}"
}
]
}
