TSWS logout

The TrueSight Web Service (TSWS) token API (DELETE) is meant for terminating a user session identified by an authToken. It uses the DELETE method to invalidate the authToken received in the request header.

Request syntax

https://<PresentationServerHostName>/tsws/api/v10.1/token

Sample request with REST client

 After accessing the REST client, perform the following steps:

1. Enter the URL for the configuration data of monitor instances API. The generic format is:
   https://<Presentation Server host name>/tsws/api/v10.1/token
2. Add a new header row and select authToken as the header type.
3. Enter the text authToken followed by the authToken generated through the token API (POST). 
   The request body is blank.
4. Select the method type as DELETE.
5. Click Send.

Request parameters

Sample request with REST client

JSON response content

The JSON response includes a status code to indicate whether the request succeeded or failed.

status

Sample JSON response and troubleshooting authentication API

The response information follows the standard HTTP response status codes. The following table contains Sample JSON response and the associated troubleshooting tips:

{
    "responseTimeStamp": "2017-05-08T19:29:18",
    "statusCode": "200",
    "statusMsg": "OK",
   "response":
    {"authPassed":true,"status":"OK"}
}

{
   "responseTimeStamp": "2017-05-09T01:24:43",
   "statusCode": "401",
   "statusMsg": "Invalid/expired token",
   "response":
    {"authPassed":true,"status":"OK"}
}

{
  "responseTimeStamp": "2017-05-09T01:25:35",
  "statusCode": "500",
  "statusMsg": "Internal Server error",
   "response":
    {"authPassed":true,"status":"OK"}
} 

{
 "responseTimeStamp":"2017-05-15T14:41:40",
 "statusCode": "503",
 "statusMsg": "Remedy SSO server is not accessible",
   "response":
    {"authPassed":true,"status":"OK"}
} 

Related topics

Developing