Chilkat Online Tools

Ruby / ForgeRock Identity Cloud Collection / Step 2: Delete Users' OAuth 2.0 Client

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# resp is a CkHttpResponse
resp = http.QuickRequest("DELETE","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/{{demoUserId}}/oauth2/applications/{{oauth2App}}?_prettyPrint=true#1.1_delete")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X DELETE
	-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/{{oauth2App}}?_prettyPrint=true#1.1_delete

Postman Collection Item JSON

{
  "name": "Step 2: Delete Users' OAuth 2.0 Client",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.test(\"Status code is 200 or 404\", function () {",
          "    pm.expect(pm.response.code).to.be.oneOf([200,404]);",
          "});",
          "",
          "if(pm.response.code === 200){",
          "",
          "    const JSONResponse = JSON.parse(responseBody);",
          "",
          "    pm.test(\"Deleted expected OAuth 2.0 app\", function () {",
          "        pm.expect(JSONResponse._id).to.eql(pm.globals.get(\"oauth2App\"));",
          "    });",
          "",
          "};"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "DELETE",
    "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/{{oauth2App}}?_prettyPrint=true#1.1_delete",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "users",
        "{{demoUserId}}",
        "oauth2",
        "applications",
        "{{oauth2App}}"
      ],
      "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."
        }
      ],
      "hash": "1.1_delete"
    },
    "description": "Delete the tokens for the specified client ID."
  },
  "response": [
    {
      "name": "Returned if the list of applications cannot be produced due to an internal error.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/oauth2/applications/{{clientId}}#1.1_delete?&_prettyPrint=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "oauth2",
            "applications",
            "{{clientId}}"
          ],
          "hash": "1.1_delete?&_prettyPrint=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": "DELETE",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/oauth2/applications/{{clientId}}#1.1_delete?&_prettyPrint=true",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "oauth2",
            "applications",
            "{{clientId}}"
          ],
          "hash": "1.1_delete?&_prettyPrint=true",
          "variable": [
            {
              "key": "user"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}