Chilkat Online Tools

DataFlex / ForgeRock Identity Cloud Collection / Step 1: Query Users' Device Profiles

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vQueryParams
    Handle hoQueryParams
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
    If (Not(IsComObjectCreated(hoQueryParams))) Begin
        Send CreateComObject of hoQueryParams
    End
    Get ComUpdateString Of hoQueryParams "_queryFilter" "true" To iSuccess

    Send ComSetRequestHeader To hoHttp "{{cookieName}}" "{{demoSSOToken}}"
    Send ComSetRequestHeader To hoHttp "Accept-API-Version" "resource=1.0"

    Get pvComObject of hoQueryParams to vQueryParams
    Get ComQuickRequestParams Of hoHttp "GET" "https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile" vQueryParams To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

Curl Command

curl -G -d "_queryFilter=true"
	-H "Accept-API-Version: resource=1.0"
	-H "{{cookieName}}: {{demoSSOToken}}"
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/profile

Postman Collection Item JSON

{
  "name": "Step 1: Query Users' Device Profiles",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const JSONResponse = JSON.parse(responseBody);",
          "",
          "// Did request contain results?",
          "if(JSONResponse.resultCount && JSONResponse.resultCount > 0)",
          "{",
          "  // Set `deviceProfileId` variable",
          "  pm.globals.set(\"deviceProfileId\", JSONResponse.result[0]._id);",
          "}",
          "else",
          "{",
          "  pm.globals.set(\"deviceProfileId\", \"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.0"
      },
      {
        "key": "{{cookieName}}",
        "value": "{{demoSSOToken}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile?_queryFilter=true",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "users",
        ":user",
        "devices",
        "profile"
      ],
      "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.",
          "disabled": true
        },
        {
          "key": "_queryFilter",
          "value": "true",
          "description": "(Required) "
        }
      ],
      "variable": [
        {
          "key": "user",
          "value": "{{demoUserId}}"
        }
      ]
    },
    "description": "Query the user devices"
  },
  "response": [
    {
      "name": "Success",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile#1.0_query_filter?&_prettyPrint=true&_queryFilter=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "profile"
          ],
          "hash": "1.0_query_filter?&_prettyPrint=true&_queryFilter=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Unexpected server error happened during the process",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/profile#1.0_query_filter?&_prettyPrint=true&_queryFilter=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "profile"
          ],
          "hash": "1.0_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}"
    }
  ]
}