Web API: Token: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The Token operation is used to login a user. All operations in the Web API require a session. The '''access token''' is returned as a response which is used to identify the session in other Web API operations. | The Token operation is used to login a user. All operations in the Web API require a session. The '''access token''' is returned as a response which is used to identify the session in other Web API operations. | ||
<pre> | <pre> | ||
Url: POST /token | Url: POST /token | ||
| Line 16: | Line 15: | ||
* '''grant_type''': '''password''' (always use that value) | * '''grant_type''': '''password''' (always use that value) | ||
The response is a JSON object with several properties | The response is a JSON object with several properties, and one of them is '''access_token''' containing the access token (session id). | ||
[[Category: QPR ProcessAnalyzer]] | [[Category: QPR ProcessAnalyzer]] | ||
Revision as of 13:48, 16 May 2020
The Token operation is used to login a user. All operations in the Web API require a session. The access token is returned as a response which is used to identify the session in other Web API operations.
Url: POST /token Content-Type: application/x-www-form-urlencoded Body: username=myUserName&password=myPassword&grant_type=password
Note that the path doesn't contain api unlike all other operations in the Web API.
Request body contains the following parameters as url encoded:
- username: Login name of the user.
- password: User password.
- grant_type: password (always use that value)
The response is a JSON object with several properties, and one of them is access_token containing the access token (session id).