Chilkat Online Tools

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

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

# 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 = chilkat.CkJsonObject()
json.UpdateString("authId","{{authId}}")
json.UpdateString("callbacks[0].type","NameCallback")
json.UpdateString("callbacks[0].output[0].name","prompt")
json.UpdateString("callbacks[0].output[0].value","User Name")
json.UpdateString("callbacks[0].input[0].name","IDToken1")
json.UpdateString("callbacks[0].input[0].value","{{IDCloudAdminUsername}}")
json.UpdateInt("callbacks[0]._id",0)
json.UpdateString("callbacks[1].type","PasswordCallback")
json.UpdateString("callbacks[1].output[0].name","prompt")
json.UpdateString("callbacks[1].output[0].value","Password")
json.UpdateString("callbacks[1].input[0].name","IDToken2")
json.UpdateString("callbacks[1].input[0].value","{{IDCloudAdminPassword}}")
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 CkHttpResponse
resp = http.PostJson3("https://<tenant-name>.forgeblocks.com/am/json/authenticate","application/json",json)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

print(str(resp.get_StatusCode()))
print(resp.bodyStr())

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": [
  ]
}