The TrueSight Web Service (TSWS) login API uses the POST method to return an authToken value in the JSON response. The authToken provides the credentials and permissions of the user performing the operations and must be specified to authenticate all subsequent TSWS API requests.
The authToken also contains an expiration date for using it.
TSWS APIs that use the POST method
| API | Description |
|---|---|
| login | Obtains the authToken required to perform all other operations |
| configdata | Retrieves configuration data of monitor instances |
| perfdata | Retrieves performance data of monitor instances |
TSWS APIs that use the GET method
| API | Description |
|---|---|
| devices | Retrieves a list of monitored devices |
| instances | Retrieves a list of monitored instances |
| monitortypes | Retrieves a list of monitor types |
| tenants | Retrieves a list of tenants |
Request syntax
https://<PresentationServerHostName>/tsws/10.0/api/authenticate/login
Request parameters
| Element | Description |
|---|---|
| username | User name performing the operation |
| password | Password to authenticate the user |
| tenantName | Tenant name as it appears in the Presentation Server Example: BmcRealm |
The request parameters in JSON format:
{
"username": "<user name>",
"password": "<password>",
"tenantName": "<tenant name>"
}
Sample request with REST client
JSON response content
The JSON response includes an authToken if the authentication is successful. You must use this authToken value for subsequent requests.
| Object | Description |
|---|---|
authToken | Value that you specify in subsequent TrueSight Web Services operations. |
authPassed | Value returned by the API. This can be either true or false. True indicates a successful operation and false indicates a failed operation. |
expires | Same as the responseTimeStamp. To perform a TrueSight Web Services operation after this date, you must perform this operation again |
status | Status returned by the API. For example, if the status code is 200, the status returned is OK. |
Sample JSON response
{
"responseTimeStamp": "2015-07-21T06:23:51",
"statusCode": "200",
"statusMsg": "OK",
"response":
{
"authToken": "AQIC5wM2LY4Sfczv3QuPxC851ZfQ-.*",
"authPassed": true,
"expires": "2015-07-21T06:23:51",
"status": "OK"
}
}
Related topics
Overview
Content Tools
Apps
Reporter Replacement
com.bmc.atlassian.bmc-util-plugin-2.section.label
Tasks
10 Comments
Gaurav Kumar
Hi,
I am getting the same value for responseTimeStamp & expires as shown in the example. Does it mean that authToken can never be used?
I am trying to get the devices using below and the authentication Token
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/devices
but getting the error response as:
{"responseTimeStamp":"2017-10-04T11:33:44","statusCode":"401","statusMsg":"401"}
Thanks
Gaurav
Priyanka Nanwani
Jonathan Macey
Harihara Subramanian
Updated it as per Jonathan Macey's comment and defect details.
Stephane Guedon
Hi
Great for login, works fine ...
What about logout ?
Regards
Stéphane
Harihara Subramanian
Thanks for your comment, Stephane Guedon. For Webservices API, the log out should be based on the timeout mechanism. I am checking internally with some SMEs. I will update you on that.
Priyanka Nanwani
Stephane Guedon
Thanks
A logout should be great to avoid useless sessions in SSO
Harihara Subramanian
Hi Stephane Guedon,
We have a logout option added in the 11.0 release. For your reference.
TSWS logout
Thanks,
Hari
Priyanka Nanwani