Skip to content

Clarify/correct session expiration #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maartenba merged 1 commit into from
Mar 28, 2025
Merged

Clarify/correct session expiration #642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions IdentityServer/v7/docs/content/ui/server_side_sessions/session_expiration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ title: "Session Expiration"
weight: 20
---

If a user abandons their session without triggering logout, the server-side session data will remain in the store by default.
In order to clean up these expired records, there is an automatic cleanup mechanism that periodically scans for expired sessions.
If the user session ends when the session cookie expires without explicitly triggering logout, there is most likely the need to clean up the server-side session data.
In order to remove these expired records, there is an automatic cleanup mechanism that periodically scans for expired sessions.
When these records are cleaned up, you can optionally notify the client that the session has ended via back-channel logout.

## Expiration Configuration

The expiration configuration features can be configured with the [server-side session options]({{<ref "/reference/options#server-side-sessions">}}).
It is enabled by default, but if you wish to disable it or change how often IdentityServer will check for expired sessions, you can.

For example:
For example, to change the interval:

```cs
builder.Services.AddIdentityServer(options => {
Expand All @@ -21,6 +21,15 @@ builder.Services.AddIdentityServer(options => {
.AddServerSideSessions();
```

To disable:

```cs
builder.Services.AddIdentityServer(options => {
options.ServerSideSessions.RemoveExpiredSessions = false;
})
.AddServerSideSessions();
```

### Back-channel Logout
When the session cleanup job removes expired records, it will by default also trigger [back-channel logout notifications]({{<ref "/ui/logout/notification#back-channel-server-side-clients">}}) to client applications participating in the session. You can use this mechanism to create an [inactivity timeout]({{<ref "inactivity_timeout">}}) that applies across all your client applications.

Expand Down