Chilkat Online Tools

PureBasic / ForgeRock Identity Cloud Collection / Step 2a: Authenticate as ID Cloud Admin using Username / Password Callback

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": "NameCallback",
    ;       "output": [
    ;         {
    ;           "name": "prompt",
    ;           "value": "User Name"
    ;         }
    ;       ],
    ;       "input": [
    ;         {
    ;           "name": "IDToken1",
    ;           "value": "{{IDCloudAdminUsername}}"
    ;         }
    ;       ],
    ;       "_id": 0
    ;     },
    ;     {
    ;       "type": "PasswordCallback",
    ;       "output": [
    ;         {
    ;           "name": "prompt",
    ;           "value": "Password"
    ;         }
    ;       ],
    ;       "input": [
    ;         {
    ;           "name": "IDToken2",
    ;           "value": "{{IDCloudAdminPassword}}"
    ;         }
    ;       ],
    ;       "_id": 1
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"authId","{{authId}}")
    CkJsonObject::ckUpdateString(json,"callbacks[0].type","NameCallback")
    CkJsonObject::ckUpdateString(json,"callbacks[0].output[0].name","prompt")
    CkJsonObject::ckUpdateString(json,"callbacks[0].output[0].value","User Name")
    CkJsonObject::ckUpdateString(json,"callbacks[0].input[0].name","IDToken1")
    CkJsonObject::ckUpdateString(json,"callbacks[0].input[0].value","{{IDCloudAdminUsername}}")
    CkJsonObject::ckUpdateInt(json,"callbacks[0]._id",0)
    CkJsonObject::ckUpdateString(json,"callbacks[1].type","PasswordCallback")
    CkJsonObject::ckUpdateString(json,"callbacks[1].output[0].name","prompt")
    CkJsonObject::ckUpdateString(json,"callbacks[1].output[0].value","Password")
    CkJsonObject::ckUpdateString(json,"callbacks[1].input[0].name","IDToken2")
    CkJsonObject::ckUpdateString(json,"callbacks[1].input[0].value","{{IDCloudAdminPassword}}")
    CkJsonObject::ckUpdateInt(json,"callbacks[1]._id",1)

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept-API-Version","resource=2.1, protocol=1.0")

    resp.i = CkHttp::ckPostJson3(http,"https://<tenant-name>.forgeblocks.com/am/json/authenticate","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": "NameCallback",
            "output": [
                {
                    "name": "prompt",
                    "value": "User Name"
                }
            ],
            "input": [
                {
                    "name": "IDToken1",
                    "value": "{{IDCloudAdminUsername}}"
                }
            ],
            "_id": 0
        },
        {
            "type": "PasswordCallback",
            "output": [
                {
                    "name": "prompt",
                    "value": "Password"
                }
            ],
            "input": [
                {
                    "name": "IDToken2",
                    "value": "{{IDCloudAdminPassword}}"
                }
            ],
            "_id": 1
        }
    ]
}'
https://<tenant-name>.forgeblocks.com/am/json/authenticate

Postman Collection Item JSON

{
  "name": "Step 2a: Authenticate as ID Cloud Admin using 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);",
          "}",
          "",
          "// Tests",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains authId\", function () {",
          "    pm.expect(JSONResponse).to.have.any.keys('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\": \"NameCallback\",\n            \"output\": [\n                {\n                    \"name\": \"prompt\",\n                    \"value\": \"User Name\"\n                }\n            ],\n            \"input\": [\n                {\n                    \"name\": \"IDToken1\",\n                    \"value\": \"{{IDCloudAdminUsername}}\"\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\": \"{{IDCloudAdminPassword}}\"\n                }\n            ],\n            \"_id\": 1\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{amUrl}}/json/authenticate",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json",
        "authenticate"
      ]
    },
    "description": "Return the Username / Password callbacks received from the previous step, specifying the credentials of an administrative user.\n"
  },
  "response": [
  ]
}