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 Endpoints | Description |
---|---|
token | Obtains the authToken required to perform all other operations |
Request syntax
https://<PresentationServerHostName>/tsws/api/v10.1/token
Sample request with REST client
After accessing the REST client, perform the following steps:
- 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 - Add a new header row and select authToken as the header type.
- Enter the text authToken followed by the authToken generated through the
token
API (POST).
The request body is blank. - Select the method type as DELETE.
- Click Send.
Sample request with REST client
JSON response content
The JSON response includes a status code to indicate whether the request succeeded or failed.
Object | Description |
---|---|
status | 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 code | Description | Sample JSON | Troubleshooting tips |
---|---|---|---|
200 | Success |
| Not applicable. |
401 | Invalid/expired token |
| Specify a valid authToken and try again. |
500 | Internal Server error |
| Try after some time or contact the TrueSight Presentation Server administrator. |
503 | Remedy SSO 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
Comments
Log in or register to comment.