Variable partnerLogoutFor

Type Declaration

• • (
        session: any,
        base: any,
    ):
        | { ok: boolean; target?: undefined; why: string }
        | {
            ok: boolean;
            target: { label: any; protocol: string; relationship: any; what: string } & {
                action: any;
                binding: string;
                fields: any;
                kind: string;
                url: string;
            };
            why?: undefined;
        }
        | {
            ok: boolean;
            target: {
                action: string;
                fields: {};
                kind: string;
                label: any;
                protocol: string;
                relationship: any;
                url: string;
                what: string;
            };
            why?: undefined;
        }

  • Builds what tells the partner a session here ended, as a link or a form the sign-out page draws: a signed SAML LogoutRequest, an OpenID Connect RP-Initiated Logout redirect, or a WS-Federation wsignout1.0.

    Parameters

    • session: any

      the sign-on session that ended

    • base: any

      the sign-out request's base URL

    Returns
        | { ok: boolean; target?: undefined; why: string }
        | {
            ok: boolean;
            target: { label: any; protocol: string; relationship: any; what: string } & {
                action: any;
                binding: string;
                fields: any;
                kind: string;
                url: string;
            };
            why?: undefined;
        }
        | {
            ok: boolean;
            target: {
                action: string;
                fields: {};
                kind: string;
                label: any;
                protocol: string;
                relationship: any;
                url: string;
                what: string;
            };
            why?: undefined;
        }

    { ok: true, target }, or { ok: false, why }