Chilkat Online Tools

Android / ForgeRock Identity Cloud Collection / Step 8. Logout Users' Session

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

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

    CkHttpResponse resp = http.QuickRequest("POST","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/sessions?_prettyPrint=true&_action=logout");
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    Log.i(TAG, String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, resp.bodyStr());


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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=logout

Postman Collection Item JSON

{
  "name": "Step 8. Logout Users' Session",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = JSON.parse(responseBody);",
          "",
          "pm.test(\"Status code is 200\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"User was logged out\", function () {",
          "    pm.expect(jsonData.result).to.eql(\"Successfully logged out\");",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableCookies": false
  },
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "(Required) ",
        "key": "Accept-API-Version",
        "value": "resource=4.0"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "{{cookieName}}",
        "type": "text",
        "value": "{{demoSSOToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{amUrl}}/json{{realm}}/sessions?_prettyPrint=true&_action=logout",
      "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": "logout",
          "description": "(Required) "
        }
      ]
    },
    "description": "It does logout from OpenAM"
  },
  "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_logout?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "sessions"
          ],
          "hash": "4.0_action_logout?&_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_logout?&_prettyPrint=true&_action=<string>",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "json{{realm}}",
            "sessions"
          ],
          "hash": "4.0_action_logout?&_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}"
    }
  ]
}