# Session timeout
Component name: <v-session-timeout>
# Examples
# Basic
# Endpoints
get-session-url response:
{
"timeLeft": 111,
"IsAuthenticated": true
}
1
2
3
4
2
3
4
extend-session-url response:
{
"timeLeft": 111
}
1
2
3
2
3
# API
| Name | Type | Description | Default |
|---|---|---|---|
| limit | Number | Indicates the TTL limit for showing the modal | 60 |
| get-session-url | String | This URL returns session TTL. The response must be valid JSON. | - |
| extend-session-url | String | This URL extends the session. The response must be valid JSON. | - |
| end-session-url | String | The URL to redirect to when session has timed out. | - |
| debug | Boolean | Enables debugging. Always shows the modal and logs to console. | false |
# Scoped Slot
In order to interact with this component, we're exposing a session object using Scoped slots (opens new window).
The session object contains the following information:
| Name | Type | Description |
|---|---|---|
| ttl | Number | The session TTL in seconds. |
| extend | Function | A function that extends the current session. |
| end | Function | A function that ends the current session. |