`"deleteSession"`

Abstract

deleteSession disconnects the client from the RPC service and closes the server-side resources the client is consuming.

The "deleteSession" action disconnects the client from the RPC service and closes the server-side resources the client is consuming. It requires a valid "authToken" from the "createSession" action.

Transactions that are not committed, are automatically rolled back.

Request examples

Minimal request example

{
  "authToken": "replaceWithValidAuthtoken",
  "api": "admin",
  "action": "deleteSession"
}

Maximal request example

{
  "requestId": "2",
  "authToken": "replaceWithValidAuthtoken",
  "api": "admin",
  "action": "deleteSession",
  "params": {},
  "responseOptions": {},
  "apiVersion": "1.0",
  "debug": "max"
}

Response examples

Successful response example

{
  "authToken": "replaceWithValidAuthtoken",
  "result": {},
  "debugInfo": {
    "request": {
      "authToken": "replaceWithValidAuthtoken",
      "api": "admin",
      "action": "deleteSession",
      "debug": "max"
    }
  },
  "errorCode": 0,
  "errorMessage": ""
}

Failure response example

{
  "authToken": "anInvalidAuthorizationToken",
  "requestId": "2",
  "debugInfo": {
    "request": {
      "authToken": "anInvalidAuthorizationToken",
      "action": "deleteSession",
      "requestId": "1"
    }
  },
  "errorCode": 12031,
  "errorMessage": "'authToken' does not match any existing session. Use a valid 'authToken' or use 'createSession' to create a valid 'authToken'."
}