diff --git a/docs/en/images/idle-message.png b/docs/en/images/idle-message.png new file mode 100644 index 0000000000..7fd297943a Binary files /dev/null and b/docs/en/images/idle-message.png differ diff --git a/docs/en/images/idle-setting.png b/docs/en/images/idle-setting.png new file mode 100644 index 0000000000..5240620e64 Binary files /dev/null and b/docs/en/images/idle-setting.png differ diff --git a/docs/en/modules/account-pro.md b/docs/en/modules/account-pro.md index 327a274f84..0dd960e97e 100644 --- a/docs/en/modules/account-pro.md +++ b/docs/en/modules/account-pro.md @@ -358,3 +358,4 @@ This module doesn't define any additional distributed event. See the [standard d * [Impersonation](./account/impersonation.md) * [Linked Accounts](./account/linkedaccounts.md) * [Session Management](./account/session-management.md) +* [Idle Session Timeout](./account/idle-session-timeout.md)] diff --git a/docs/en/modules/account/idle-session-timeout.md b/docs/en/modules/account/idle-session-timeout.md new file mode 100644 index 0000000000..78eb84d81b --- /dev/null +++ b/docs/en/modules/account/idle-session-timeout.md @@ -0,0 +1,19 @@ +# Idle Session Timeout + +Idle Session Timeout feature allows you to automatically log out users after a certain period of inactivity. + +## Configure Idle Session Timeout + +You can enable/disable the `Idle Session Timeout` feature in the `Setting -> Account -> Idle Session Timeout` page. + +The default idle session timeout is 1 hour. You can change it by selecting a different value from the dropdown list or entering a custom value(in minutes). + +![idle-setting](../../images/idle-setting.png) + +Once the idle session timeout is reached, the user will see a warning modal before being logged out. if user does not respond for 60 seconds, the user will be logged out automatically. + +![idle-setting](../../images/idle-message.png) + +## How it works + +There is JavaScript code running in the background to detect user activity. such as mouse movement, key press, click, etc. If there is no activity detected for setting time, The warning modal will be shown to the user.