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.

TSWS API that use the POST method
API EndpointsDescription
tokenObtains the authToken required to perform all other operations

Request syntax


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



Value of the authToken


Sample request with REST client

JSON response content

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

Value returned as OK <Check with Suhas for the value>.

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:

Status codeDescriptionSample JSONTroubleshooting tips
    "responseTimeStamp": "2017-05-08T19:29:18",
    "statusCode": "200",
    "statusMsg": "OK",
Not applicable.
401Invalid/expired token
   "responseTimeStamp": "2017-05-09T01:24:43",
   "statusCode": "401",
   "statusMsg": "Invalid/expired token",
Specify a valid authToken and try again.
500Internal Server error
  "responseTimeStamp": "2017-05-09T01:25:35",
  "statusCode": "500",
  "statusMsg": "Internal Server error",

Try after some time or contact the TrueSight Presentation Server administrator.

503Remedy SSO is not accessible
 "statusCode": "503",
 "statusMsg": "Remedy SSO server is not accessible",

Try after some time or contact the TrueSight Presentation Server administrator.

Related topics


Was this page helpful? Yes No Submitting... Thank you