auth.provider API
    Preparing search index...

    Interface SessionFamilyIndex

    Sid-keyed index of refresh-token family ids. Source data for cascade revocation in the logout flow (consumes A3's RefreshTokenFamilyRevocation). Per A4 §5.3.

    Mutability: append-only (idempotent on duplicate familyId); cleanup via removeBySid. Per-family removal is not exposed.

    TTL contract: every addFamilyId MUST be called with the session's expiresAt.

    interface SessionFamilyIndex {
        kind: string;
        addFamilyId(sid: string, familyId: string, expiresAt: Date): Promise<void>;
        listFamilyIds(sid: string): Promise<readonly string[]>;
        removeBySid(sid: string): Promise<void>;
    }
    Index

    Properties

    kind

    Methods

    addFamilyId listFamilyIds removeBySid

    Properties

    kind: string

    Methods

    • Expiry encoding: Date per A4 two-tier design — see UserSession for rationale.

      Parameters

      • sid: string
      • familyId: string
      • expiresAt: Date

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods