wsfed-caep-nodejs
    Preparing search index...

    Interface SignalsReceiverOptions

    interface SignalsReceiverOptions {
        description?: string;
        endOn?: readonly string[];
        eventsRequested?: readonly string[];
        headers?: () => Record<string, string> | Promise<Record<string, string>>;
        log?: Pick<Console, "error" | "info" | "warn">;
        maxEvents?: number;
        onEndSessions: (
            localIds: string[],
            event: SignalEvent,
        ) => void | Promise<void>;
        pollIntervalMs?: number;
        sessionIndex?: SessionIndex;
        subjectAttribute?: string;
        tls?: BackChannelOptions;
        transmitter: string;
    }
    Index
    description? endOn? eventsRequested? headers? log? maxEvents? onEndSessions pollIntervalMs? sessionIndex? subjectAttribute? tls? transmitter
    description?: string

    A description of the stream, shown at the transmitter.

    endOn?: readonly string[]

    The event types that END the matching local sessions. Default: session-revoked, account-disabled, account-purged, credential-compromise, sessions-revoked.

    eventsRequested?: readonly string[]

    The event types to ask for. Default: CAEP's session and credential events and RISC's account events.

    headers?: () => Record<string, string> | Promise<Record<string, string>>

    Extra headers for every call (e.g. an authorization header), for a transmitter that wants one.

    log?: Pick<Console, "error" | "info" | "warn">

    Where the receiver logs. Default console.

    maxEvents?: number

    At most this many SETs per poll. Default 50.

    onEndSessions: (localIds: string[], event: SignalEvent) => void | Promise<void>

    Called with the local sessions an event ends. End them in the application's session store.

    pollIntervalMs?: number

    How long to wait between polls when nothing was waiting, in milliseconds. Default 5000.

    sessionIndex?: SessionIndex

    The session index; default one process's memory.

    subjectAttribute?: string

    The assertion attribute (claim) holding the person's subject. Default iya-sts's (and AD FS's) nameidentifier claim.

    tls?: BackChannelOptions

    TLS for every call to the transmitter: ca to trust, and cert + key to present (mutual TLS).

    transmitter: string

    The transmitter's issuer, e.g. https://idp.example.com; its configuration is read from /.well-known/ssf-configuration there.

    Settings
    Member Visibility

    On This Page
    Properties