Chilkat Online Tools

VBScript / ForgeRock Identity Cloud Collection / Step 2b: Handle Validated Username / Password Callback

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

' 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 CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("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": "ValidatedCreateUsernameCallback",
'       "output": [
'         {
'           "name": "policies",
'           "value": {}
'         },
'         {
'           "name": "failedPolicies",
'           "value": [
'           ]
'         },
'         {
'           "name": "validateOnly",
'           "value": false
'         },
'         {
'           "name": "prompt",
'           "value": "Username"
'         }
'       ],
'       "input": [
'         {
'           "name": "IDToken1",
'           "value": "{{postmanDemoUsername}}"
'         },
'         {
'           "name": "IDToken1validateOnly",
'           "value": false
'         }
'       ],
'       "_id": 0
'     },
'     {
'       "type": "ValidatedCreatePasswordCallback",
'       "output": [
'         {
'           "name": "echoOn",
'           "value": false
'         },
'         {
'           "name": "policies",
'           "value": {}
'         },
'         {
'           "name": "failedPolicies",
'           "value": [
'           ]
'         },
'         {
'           "name": "validateOnly",
'           "value": false
'         },
'         {
'           "name": "prompt",
'           "value": "Password"
'         }
'       ],
'       "input": [
'         {
'           "name": "IDToken2",
'           "value": "{{postmanDemoPassword}}"
'         },
'         {
'           "name": "IDToken2validateOnly",
'           "value": false
'         }
'       ],
'       "_id": 1
'     }
'   ]
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("authId","{{authId}}")
success = json.UpdateString("callbacks[0].type","ValidatedCreateUsernameCallback")
success = json.UpdateString("callbacks[0].output[0].name","policies")
success = json.UpdateNewObject("callbacks[0].output[0].value")
success = json.UpdateString("callbacks[0].output[1].name","failedPolicies")
success = json.UpdateNewArray("callbacks[0].output[1].value")
success = json.UpdateString("callbacks[0].output[2].name","validateOnly")
success = json.UpdateBool("callbacks[0].output[2].value",0)
success = json.UpdateString("callbacks[0].output[3].name","prompt")
success = json.UpdateString("callbacks[0].output[3].value","Username")
success = json.UpdateString("callbacks[0].input[0].name","IDToken1")
success = json.UpdateString("callbacks[0].input[0].value","{{postmanDemoUsername}}")
success = json.UpdateString("callbacks[0].input[1].name","IDToken1validateOnly")
success = json.UpdateBool("callbacks[0].input[1].value",0)
success = json.UpdateInt("callbacks[0]._id",0)
success = json.UpdateString("callbacks[1].type","ValidatedCreatePasswordCallback")
success = json.UpdateString("callbacks[1].output[0].name","echoOn")
success = json.UpdateBool("callbacks[1].output[0].value",0)
success = json.UpdateString("callbacks[1].output[1].name","policies")
success = json.UpdateNewObject("callbacks[1].output[1].value")
success = json.UpdateString("callbacks[1].output[2].name","failedPolicies")
success = json.UpdateNewArray("callbacks[1].output[2].value")
success = json.UpdateString("callbacks[1].output[3].name","validateOnly")
success = json.UpdateBool("callbacks[1].output[3].value",0)
success = json.UpdateString("callbacks[1].output[4].name","prompt")
success = json.UpdateString("callbacks[1].output[4].value","Password")
success = json.UpdateString("callbacks[1].input[0].name","IDToken2")
success = json.UpdateString("callbacks[1].input[0].value","{{postmanDemoPassword}}")
success = json.UpdateString("callbacks[1].input[1].name","IDToken2validateOnly")
success = json.UpdateBool("callbacks[1].input[1].value",0)
success = json.UpdateInt("callbacks[1]._id",1)

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept-API-Version","resource=2.1, protocol=1.0"

' resp is a Chilkat.HttpResponse
Set 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) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

' 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")

outFile.Close

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept-API-Version: resource=2.1, protocol=1.0"
	-d '{
    "authId": "{{authId}}",
    "callbacks": [
        {
            "type": "ValidatedCreateUsernameCallback",
            "output": [
                {
                    "name": "policies",
                    "value": {}
                },
                {
                    "name": "failedPolicies",
                    "value": []
                },
                {
                    "name": "validateOnly",
                    "value": false
                },
                {
                    "name": "prompt",
                    "value": "Username"
                }
            ],
            "input": [
                {
                    "name": "IDToken1",
                    "value": "{{postmanDemoUsername}}"
                },
                {
                    "name": "IDToken1validateOnly",
                    "value": false
                }
            ],
            "_id": 0
        },
        {
            "type": "ValidatedCreatePasswordCallback",
            "output": [
                {
                    "name": "echoOn",
                    "value": false
                },
                {
                    "name": "policies",
                    "value": {}
                },
                {
                    "name": "failedPolicies",
                    "value": []
                },
                {
                    "name": "validateOnly",
                    "value": false
                },
                {
                    "name": "prompt",
                    "value": "Password"
                }
            ],
            "input": [
                {
                    "name": "IDToken2",
                    "value": "{{postmanDemoPassword}}"
                },
                {
                    "name": "IDToken2validateOnly",
                    "value": false
                }
            ],
            "_id": 1
        }
    ]
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login

Postman Collection Item JSON

{
  "name": "Step 2b: Handle Validated Username / Password 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.1, protocol=1.0"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"authId\": \"{{authId}}\",\n    \"callbacks\": [\n        {\n            \"type\": \"ValidatedCreateUsernameCallback\",\n            \"output\": [\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\": \"prompt\",\n                    \"value\": \"Username\"\n                }\n            ],\n            \"input\": [\n                {\n                    \"name\": \"IDToken1\",\n                    \"value\": \"{{postmanDemoUsername}}\"\n                },\n                {\n                    \"name\": \"IDToken1validateOnly\",\n                    \"value\": false\n                }\n            ],\n            \"_id\": 0\n        },\n        {\n            \"type\": \"ValidatedCreatePasswordCallback\",\n            \"output\": [\n                {\n                    \"name\": \"echoOn\",\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\": \"prompt\",\n                    \"value\": \"Password\"\n                }\n            ],\n            \"input\": [\n                {\n                    \"name\": \"IDToken2\",\n                    \"value\": \"{{postmanDemoPassword}}\"\n                },\n                {\n                    \"name\": \"IDToken2validateOnly\",\n                    \"value\": false\n                }\n            ],\n            \"_id\": 1\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 the `ValidatedCreateUsernameCallback` and `ValidatedCreatePasswordCallback` callbacks."
  },
  "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\": \"NameCallback\",\n            \"output\": [\n                {\n                    \"name\": \"prompt\",\n                    \"value\": \"User Name\"\n                }\n            ],\n            \"input\": [\n                {\n                    \"name\": \"IDToken1\",\n                    \"value\": \"{{postmanDemoUsername}}\"\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\": \"{{postmanDemoPassword}}\"\n                }\n            ],\n            \"_id\": 1\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=0_OKRrdKWp4qNlomyaBn3lRl23U.*AAJTSQACMDEAAlNLABxiNmZiTnVSV05IbUFNbWprV3ZndUlNdlVYNDg9AAR0eXBlAANDVFMAAlMxAAA.*; 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:08:53 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"tokenId\": \"N60dPV99pcqVVI.*AAJTSQACMDEAAANDVFMAAlMxAAA.*\",\n    \"successUrl\": \"/openam/console\",\n    \"realm\": \"/\"\n}"
    }
  ]
}