Chilkat Online Tools

phpAx / ForgeRock Identity Cloud Collection / Step 6: Refresh Users' Session

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('POST','https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/sessions?_prettyPrint=true&_action=refresh');
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "Accept-API-Version: resource=4.0"
	-H "Content-Type: application/json"
	-H "{{cookieName}}: {{demoSSOToken}}"
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/sessions?_prettyPrint=true&_action=refresh

Postman Collection Item JSON

{
  "name": "Step 6: Refresh Users' Session",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.test(\"Status code is 200\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "type": "text",
        "value": "resource=4.0"
      },
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "{{cookieName}}",
        "type": "text",
        "value": "{{demoSSOToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/sessions?_prettyPrint=true&_action=refresh",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "json{{realm}}",
        "sessions"
      ],
      "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": "refresh"
        }
      ]
    },
    "description": "Suggests to OpenAM that it should refresh this session (update it's latest access time and reset its idleTime to 0). This will only be obeyed if the time between the session's previous latest access time and now is greater than the value configured for the server's Latest Access Time Update Frequency setting, which defaults to 60 seconds."
  },
  "response": [
    {
      "name": "Success",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"tokenId\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/sessions#4.0_action_refresh?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "sessions"
          ],
          "hash": "4.0_action_refresh?&_prettyPrint=true&_action=<string>"
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "*/*"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "It happens when when the SSO header is missing in the request or user token is not valid.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "(Required) ",
            "key": "Accept-API-Version",
            "value": "resource=1.0"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"tokenId\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{amUrl}}/json{{realm}}/sessions#4.0_action_refresh?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "sessions"
          ],
          "hash": "4.0_action_refresh?&_prettyPrint=true&_action=<string>"
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_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}"
    }
  ]
}