End point: [RemoteTM URL]/remote
Send a GET request with these headers:
Content-Type |
application/json |
Authorization |
BASIC authentication code |
The value part of Authorization header is constructed as follows:
- Combine username + ‘:’ (colon character) + password into
a single string. Notice that the username field cannot contain a colon.
- Encode the string generated in step 1 using Base64.
- Prepend "BASIC " to the string encoded in step 2.
For example, if the value of username is services and the password is
magic#123, the string to be encoded using Base64 is
services:magic#123. Then, the header to be sent to RemoteTM is:
Authorization: BASIC c2VydmljZXM6bWFnaWMjMTIz
RemoteTM responds with a JSON object.
On success, the value of "status" field is "OK", "ticket"
field contains the authorization code issued by RemoteTM and "role" field
contains the user's role. Example:
{
"status": "OK",
"ticket": "28ceb966-150e-4b27-b603-c244160da5b7",
"role": "PM"
}
On error, field "status" is set to "Error" and failure reason is
indicated in the "reason" field. Example:
{
"status": "Error",
"reason": "Access Denied"
}