REST API for retrieving authentication token

Edit online

You use the POST operation on the api/get_token element to request your unique token that is required to authenticate the REST API requests.

Important: This REST API call does not work when single sign-on authentication is enabled. To view the token, log in to License Metric Tool, hover over the User icon User icon, and click Profile. Then, click Show token.

Resource URL

https://hostname:port/api/get_token

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns the authentication token
HTTP method POST
Request headers
Accept-Language (optional)
  • Use: Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
  • Values: en-US (only English is supported)
Request payload 
{
	"user" : "username",
	"password" : "password"
}
Request Content-Type
  • application/json
Response headers
Content-Type
  • Use: Specifies the content type of the response.
  • Values: application/json
Content-Language
  • Use: Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
  • Values: en-US, …
Response payload Token element
Response Content-Type
  • application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 500 – “Bad Request” if a query parameter contains errors or is missing

Message body includes an error message with details.

Example HTTP conversation

Request
POST https://hostname:port/api/get_token
Request header
Accept: application/json
Accept-Language: en-US
Content-Type: application/json
Request body
{
	"user" : "admin",
	"password" : "<password>"
}
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Response body (JSON)
{
"token":"<token>"
}