Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Duende.IdentityServer.Configuration.ServerSideSessionOptions
Assembly: Duende.IdentityServer
Inheritance: object → ServerSideSessionOptions
Settings for server-side session storage, including periodic cleanup of expired sessions and back-channel logout integration.
Properties
public
string
UserDisplayNameClaimType
Gets or sets the claim type used to populate the display name shown for a user's session in
management UIs.
Remarks Defaults to <c>null</c> (unset) due to potential PII concerns. Common values are
<c>JwtClaimTypes.Name</c> , <c>JwtClaimTypes.Email</c> , or a custom claim type.
public
bool
RemoveExpiredSessions
Gets or sets a value indicating whether a background job that periodically removes expired server-side sessions is enabled.
Remarks Defaults to <c>true</c> . The cleanup frequency is controlled by
<see cref="P:Duende.IdentityServer.Configuration.ServerSideSessionOptions.RemoveExpiredSessionsFrequency" /> .
public
bool
ExpiredSessionsTriggerBackchannelLogout
Gets or sets a value indicating whether back-channel logout notifications are sent to clients when server-side sessions are removed
due to expiration.
Remarks Defaults to <c>false</c> . When enabled, expiring a server-side session effectively ties
the user's session lifetime at each client to their session lifetime at IdentityServer.
public
System.TimeSpan
RemoveExpiredSessionsFrequency
Gets or sets how often the background job runs to remove expired server-side sessions.
Remarks Defaults to 10 minutes. Only relevant when <see cref="P:Duende.IdentityServer.Configuration.ServerSideSessionOptions.RemoveExpiredSessions" /> is
<c>true</c> .
public
bool
FuzzExpiredSessionRemovalStart
Gets or sets a value indicating whether the initial start time of the expired-session cleanup job is randomized to reduce the
likelihood of concurrent cleanup conflicts when multiple server instances are running.
Remarks Defaults to <c>true</c> . When enabled, the first cleanup run is scheduled at a random
time between host startup and the first <see cref="P:Duende.IdentityServer.Configuration.ServerSideSessionOptions.RemoveExpiredSessionsFrequency" />
interval. Subsequent runs follow the configured frequency.
public
int
RemoveExpiredSessionsBatchSize
Gets or sets the maximum number of expired session records deleted in a single cleanup batch.
Remarks Defaults to 100. Tune this value to balance cleanup throughput against database load.
Methods
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object