GET /api/v1/auth/heartbeat
Use this method to return whether the current user session is active and has a valid access token.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/auth/heartbeat
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| secondsLeftInFullOperationTimeout | Integer | Amount of time, in seconds, that is left before the full-operations timeout expires When the session is active, the timer resets every time the user performs any action. If this timeout value is exceeded but the primary view-operations timeout value is not exceeded, the user can continue to perform view-only actions (such as opening or refreshing a page) until the primary view-operations timeout value is exceeded; however, if the user attempts to perform an action that modifies data, the user session expires and the login page is displayed. This value is 0 if the timeout expired. This value is -1 if the timeout is disabled. | ||
| secondsLeftInViewOperationTimeout | Integer | Amount of time, in seconds, that is left before the view-operations timeout expires When the session is active, the timer resets every time the user performs any action. After the timeout value is exceeded, the login page is displayed the next time the user attempts to perform an action. This value is 0 if the timeout expired. This value is -1 if the timeout is disabled. | ||
{
"secondsLeftInFullOperationTimeout": 1157,
"secondsLeftInViewOperationTimeout": 85757
}