Skip to content
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

Jump to bottom

Corrected discussion of session options #326

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Corrected discussion of session options #326

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
17 changes: 3 additions & 14 deletions IdentityServer/v6/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 @@ -10,7 +10,7 @@ When these records are cleaned up, you can optionally notify the client that the
## 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 the frequency it runs you can.
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:

Expand All @@ -25,18 +25,7 @@ public void ConfigureServices(IServiceCollection services)
```

### Back-channel Logout
When these expired records are removed you can optionally trigger [back-channel logout notification]({{<ref "/ui/logout/notification#back-channel-server-side-clients">}}).
To do so, you must enable the feature with the *ExpiredSessionsTriggerBackchannelLogout* option on the [server-side session options]({{<ref "/reference/options#server-side-sessions">}}).
This is not enabled by default.
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.

For example:
The *ServerSideSessions.ExpiredSessionsTriggerBackchannelLogout* flag enables this behavior, and it is on by default.

```cs
public void ConfigureServices(IServiceCollection services)
{
services.AddIdentityServer(options => {
options.ServerSideSessions.ExpiredSessionsTriggerBackchannelLogout = true;
})
.AddServerSideSessions();
}
```
Loading