How to configure User Session Timeout
The User Session Timeout policy enables you to define a maximum idle time, ensuring that sessions are automatically terminated after a period of inactivity. It also allows you to define a maximum session time to avoid sessions staying open indefinitely.
This guide walks you through configuring the User Session Timeout policy.
Go to User Session Timeout referenceConfiguring a user session timeout
- Run the following
GET
request in your terminal to obtain the current values for the User Session Timeout in your account.
- You’ll receive a response similar to this:
This means the policy is configured with 1 minute for the maximum idle time and 5 minutes for the maximum session time.
- Run the following
PUT
request in your terminal to update the values for the User Session Timeout in your account.
Where:
Key | Type | Description |
---|---|---|
max_idle_time | Integer | Defines the period of inactivity after which a session is automatically terminated. The value must be in minutes. Default value and maximum idle time allowed: 1440 , equivalent to 1 day |
max_session_time | Integer | Defines the total time a session can remain active, regardless of activity, ensuring sessions don’t stay open indefinitely. The value must be in minutes, between 5 minutes and 21600 minutes, equivalent to 15 days. Default value: 21600 |
- You’ll receive a response similar to this:
Done. The User Session Timeout is now configured with the new values.