Chilkat Online Tools

lianja / ForgeRock Identity Cloud Collection / Step 1: Query Users' OAuth 2.0 Clients

Back to Collection Items

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

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("_prettyPrint","true")
loQueryParams.UpdateString("_queryFilter","true")

loHttp.SetRequestHeader("{{cookieName}}","{{demoSSOToken}}")
loHttp.SetRequestHeader("Accept-API-Version","resource=1.1")

loResp = loHttp.QuickRequestParams("GET","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/{{demoUserId}}/oauth2/applications",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "_prettyPrint=true"
	-d "_queryFilter=true"
	-H "Accept-API-Version: resource=1.1"
	-H "{{cookieName}}: {{demoSSOToken}}"
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/{{demoUserId}}/oauth2/applications

Postman Collection Item JSON

{
  "name": "Step 1: Query Users' OAuth 2.0 Clients",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const JSONResponse = JSON.parse(responseBody);",
          "",
          "// Did request contain results?",
          "if(JSONResponse.resultCount && JSONResponse.resultCount > 0)",
          "{",
          "  // Set `demoSSOToken` variable",
          "  pm.globals.set(\"oauth2App\", JSONResponse.result[0]._id);",
          "}",
          "else",
          "{",
          "  pm.globals.set(\"oauth2App\", \"none_found\");  ",
          "}",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains resultCount\", function () {",
          "    pm.expect(JSONResponse.resultCount).to.be.a(\"number\");",
          "});",
          "",
          "pm.test(\"Response contains at least one result\", function () {",
          "    pm.expect(JSONResponse.resultCount).to.be.above(0);",
          "});",
          "",
          "",
          "",
          "",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "value": "resource=1.1"
      },
      {
        "key": "{{cookieName}}",
        "value": "{{demoSSOToken}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/users/{{demoUserId}}/oauth2/applications?_prettyPrint=true&_queryFilter=true",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "users",
        "{{demoUserId}}",
        "oauth2",
        "applications"
      ],
      "query": [
        {
          "key": "_fields",
          "value": "",
          "description": "Optional parameter containing a comma separated list of field references specifying which fields of the targeted JSON resource should be returned.",
          "disabled": true
        },
        {
          "key": "_prettyPrint",
          "value": "true",
          "description": "Optional parameter requesting that the returned JSON resource content should be formatted to be more human readable."
        },
        {
          "key": "_queryFilter",
          "value": "true",
          "description": "(Required) "
        }
      ]
    },
    "description": "Get a list of the applications that have been granted OAuth 2.0 access. Only `_queryFilter=true` is supported."
  },
  "response": [
    {
      "name": "Returned if the list of applications cannot be produced due to an internal error.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/oauth2/applications#1.1_query_filter?&_prettyPrint=true&_queryFilter=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "oauth2",
            "applications"
          ],
          "hash": "1.1_query_filter?&_prettyPrint=true&_queryFilter=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": 93541721,\n \"message\": \"minim\",\n \"reason\": \"sint Excepteur\",\n \"detail\": \"veniam id qui\"\n}"
    },
    {
      "name": "Success",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/oauth2/applications#1.1_query_filter?&_prettyPrint=true&_queryFilter=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "oauth2",
            "applications"
          ],
          "hash": "1.1_query_filter?&_prettyPrint=true&_queryFilter=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}