auth.provider API
    Preparing search index...

    Interface GenerateLogoutTokenOptions

    Options for generateLogoutToken (OIDC Back-Channel Logout 1.0).

    interface GenerateLogoutTokenOptions {
        aud: string | string[];
        expiresIn?: number;
        includeSid?: boolean;
        issuer: string;
        keyStore: KeyStore;
        sid?: string;
        sub: string;
    }
    Index

    Properties

    aud expiresIn? includeSid? issuer keyStore sid? sub

    Properties

    aud: string | string[]

    Audience — the client_id of the RP receiving this logout_token.

    expiresIn?: number

    TTL in seconds. Defaults to 300 (5 minutes) per Back-Channel Logout 1.0 best practice.

    includeSid?: boolean

    Whether to include the sid claim. Defaults to true for security — most RPs require sid to correlate the logout with their local session. Set to false only when the RP registered with backchannel_logout_session_required: false.

    issuer: string

    Issuer URL (MUST match the id_token iss claim for the session being logged out).

    keyStore: KeyStore

    JWT signer.

    sid?: string

    Session identifier (MUST match the id_token sid claim when present).

    sub: string

    Subject identifier of the user being logged out.

    Settings

    Member Visibility

    On This Page

    Properties