Chilkat Online Tools

phpExt / ForgeRock Identity Cloud Collection / Step 4: [Admin] Reset (Remove) Users' OATH Device

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new 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.

// {}

$json = new CkJsonObject();

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept-API-Version','resource=1.0');
$http->SetRequestHeader('{{cookieName}}','{{adminSSOToken}}');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/2fa/oath?_prettyPrint=true&_action=reset','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Accept-API-Version: resource=1.0"
	-H "Content-Type: application/json"
	-H "{{cookieName}}: {{adminSSOToken}}"
	-d '"<object>"'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/users/:user/devices/2fa/oath?_prettyPrint=true&_action=reset

Postman Collection Item JSON

{
  "name": "Step 4: [Admin] Reset (Remove) Users' OATH Device",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "value": "resource=1.0"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "{{cookieName}}",
        "type": "text",
        "value": "{{adminSSOToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "\"<object>\""
    },
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/2fa/oath?_prettyPrint=true&_action=reset",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "users",
        ":user",
        "devices",
        "2fa",
        "oath"
      ],
      "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": "_action",
          "value": "reset",
          "description": "(Required) "
        }
      ],
      "variable": [
        {
          "key": "user",
          "value": "{{demoUserId}}",
          "description": "(Required) The identifier for the user for which the request is regarding."
        }
      ]
    },
    "description": "Sets the user's 'skippable' selection of Authenticator OATH module to default (NOT_SET) and deletes their profiles attribute"
  },
  "response": [
    {
      "name": "Success",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "\"<object>\""
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/2fa/oath#1.0_action_reset?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "2fa",
            "oath"
          ],
          "hash": "1.0_action_reset?&_prettyPrint=true&_action=<string>",
          "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": "POST",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "\"<object>\""
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/users/:user/devices/2fa/oath#1.0_action_reset?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "users",
            ":user",
            "devices",
            "2fa",
            "oath"
          ],
          "hash": "1.0_action_reset?&_prettyPrint=true&_action=<string>",
          "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}"
    }
  ]
}