Authenticate against the API
POST/ops/login
The login endpoint returns a JSON web token that should be used in the Authorization header of all subsequent requests.
Request
- application/json
Body
required
Possible values: <= 50 characters
The username of your terminal management system (TMS) account.
The password of your terminal management system (TMS) account.
Responses
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
tokenDetails object
Token value to use in the Authorization header of all subsequent requests.
Refresh token value to use in the Authorization header of all subsequent requests.
Scopes granted to the user.
Expiration date/time of the token.
user object
The username logged in.
Name of the user logged in.
Email of the user logged in.
Role of the user logged in.
Creation date/time of the user.
{
"tokenDetails": {
"accessToken": "string",
"refreshToken": "string",
"scopes": "string",
"expirationDatetime": "string"
},
"user": {
"username": "string",
"name": "string",
"email": "string",
"role": "string",
"created": "string"
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error code.
Reason of the error.
Message guid of the error.
{
"code": "string",
"reason": "string",
"messageGuid": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error code.
Reason of the error.
Message guid of the error.
{
"code": "string",
"reason": "string",
"messageGuid": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error code.
Reason of the error.
Message guid of the error.
{
"code": "string",
"reason": "string",
"messageGuid": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Error code.
Reason of the error.
Message guid of the error.
{
"code": "string",
"reason": "string",
"messageGuid": "string"
}