Interface SessionCheckOptions

Both modes send id_token_hint if a stored token is available; the AS falls back to the browser session cookie if it is absent. This means a session check can succeed even without stored tokens.

  • id_token mode: returns a fresh id_token with claims. subject is validated if provided.
  • none mode: returns no claims. Success is detected by the iframe landing on the redirect URI.
interface SessionCheckOptions {
    redirectUri?: string;
    responseType?: SessionCheckResponseType;
    scope?: string;
    subject?: string;
}

Properties

redirectUri? responseType? scope? subject?

Properties

OptionalredirectUri

redirectUri?: string

Overrides OidcConfig.redirectUri for the session check request.

OptionalresponseType

responseType?: SessionCheckResponseType

The response type for the session check. Default: SessionCheckResponseType.None

Optionalscope

scope?: string

OAuth scope. Default: 'openid'.

Optionalsubject

subject?: string

If provided, the sub claim in the returned id_token must match. id_token mode only.

Settings

Member Visibility

On This Page

Properties