Skip to content

Commit

Permalink
Add session timeout related configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
shanggeeth committed Sep 1, 2024
1 parent 8d54a6a commit 211c673
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 0 deletions.
10 changes: 10 additions & 0 deletions en/identity-server/6.0.0/docs/deploy/session-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ This guide walks you through the process of enabling session persistence for ses

This cookie can be seen as **commonauthId**. It is set to the user’s browser with the hostname of the WSO2 Identity Server instance and the value of the **commonauthId** cookie is the SSO session identifier. When an SSO session is created in the WSO2 Identity Server, the session is put into the session cache and persisted in the database. To persist it into the database, you must enable session persistence.

## Session Timeout related configurations

The `[session.timeout]` section is related to the session timeout configurations.

| Configuration element | Description |
|-----------------------|------------ |
| `idle_session_timeout` | This is the time in minutes after which the session times out if the user is idle. The default value is `15m`. |
| `remember_me_session_timeout` | This is the time in minutes after which the session times out if the user selects the **Remember Me** option. The default value is `14d`. |
| `extend_remember_me_session_timeout_on_auth` | This is a boolean value that determines whether the session timeout from **Remember Me** option is extended when the user is authenticated again without prompting credentials. The default value is `true`. |

## Importance of session persistence

SSO sessions are stored in an in-memory cache. It is recommended to persist the SSO session due to the following reasons.
Expand Down
10 changes: 10 additions & 0 deletions en/identity-server/6.1.0/docs/deploy/session-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ This guide walks you through the process of enabling session persistence for ses

This cookie can be seen as **commonauthId**. It is set to the user’s browser with the hostname of the WSO2 Identity Server instance and the value of the **commonauthId** cookie is the SSO session identifier. When an SSO session is created in the WSO2 Identity Server, the session is put into the session cache and persisted in the database. To persist it into the database, you must enable session persistence.

## Session Timeout related configurations

The `[session.timeout]` section is related to the session timeout configurations.

| Configuration element | Description |
|-----------------------|------------ |
| `idle_session_timeout` | This is the time in minutes after which the session times out if the user is idle. The default value is `15m`. |
| `remember_me_session_timeout` | This is the time in minutes after which the session times out if the user selects the **Remember Me** option. The default value is `14d`. |
| `extend_remember_me_session_timeout_on_auth` | This is a boolean value that determines whether the session timeout from **Remember Me** option is extended when the user is authenticated again without prompting credentials. The default value is `true`. |

## Importance of session persistence

SSO sessions are stored in an in-memory cache. It is recommended to persist the SSO session due to the following reasons.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ This guide walks you through the process of enabling session persistence for ses

This cookie can be seen as **commonauthId**. It is set to the user’s browser with the hostname of the WSO2 Identity Server instance and the value of the **commonauthId** cookie is the SSO session identifier. When an SSO session is created in the WSO2 Identity Server, the session is put into the session cache and persisted in the database. To persist it into the database, you must enable session persistence.

## Session Timeout related configurations

The `[session.timeout]` section is related to the session timeout configurations.

| Configuration element | Description |
|-----------------------|------------ |
| `idle_session_timeout` | This is the time in minutes after which the session times out if the user is idle. The default value is `15m`. |
| `remember_me_session_timeout` | This is the time in minutes after which the session times out if the user selects the **Remember Me** option. The default value is `14d`. |
| `extend_remember_me_session_timeout_on_auth` | This is a boolean value that determines whether the session timeout from **Remember Me** option is extended when the user is authenticated again without prompting credentials. The default value is `true`. |

## Importance of session persistence

SSO sessions are stored in an in-memory cache. It is recommended to persist the SSO session due to the following reasons.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ This guide walks you through the process of enabling session persistence for ses

This cookie can be seen as **commonauthId**. It is set to the user’s browser with the hostname of the WSO2 Identity Server instance and the value of the **commonauthId** cookie is the SSO session identifier. When an SSO session is created in the WSO2 Identity Server, the session is put into the session cache and persisted in the database. To persist it into the database, you must enable session persistence.

## Session Timeout related configurations

The `[session.timeout]` section is related to the session timeout configurations.

| Configuration element | Description |
|-----------------------|------------ |
| `idle_session_timeout` | This is the time in minutes after which the session times out if the user is idle. The default value is `15m`. |
| `remember_me_session_timeout` | This is the time in minutes after which the session times out if the user selects the **Remember Me** option. The default value is `14d`. |
| `extend_remember_me_session_timeout_on_auth` | This is a boolean value that determines whether the session timeout from **Remember Me** option is extended when the user is authenticated again without prompting credentials. The default value is `true`. |

## Importance of session persistence

SSO sessions are stored in an in-memory cache. It is recommended to persist the SSO session due to the following reasons.
Expand Down

0 comments on commit 211c673

Please sign in to comment.