@inrupt/solid-client-authn-core
    Preparing search index...

    Interface IRpLogoutOptions

    interface IRpLogoutOptions {
        handleRedirect?: (redirectUrl: string) => void;
        logoutType: "idp";
        postLogoutUrl?: string;
        state?: string;
    }
    Index

    Properties

    handleRedirect? logoutType postLogoutUrl? state?

    Properties

    handleRedirect?: (redirectUrl: string) => void

    If a function is provided, the browser will not auto-redirect and will instead trigger that function to redirect. Required in non-browser environments, ignored in the browser.

    logoutType: "idp"

    Log out with through from the RP.

    postLogoutUrl?: string

    An optional URL to redirect to after idp logout has completed; this MUST match a logout URL listed in the Client ID Document of the application that is logged in.

    If the application is logged in with a Client ID that is not a URI dereferencing to a Client ID Document then users will not be redirected back to the postLogoutUrl after logout.

    state?: string

    The value that should be provided in the state query parameter when redirecting back to the postLogoutUrl.

    Note: This parameter should only be provided when a postLogoutUrl is provided. If this value is provided then you should clear it from the URL when redirected back to the postLogoutUrl.

    Settings

    Member Visibility

    On This Page

    Properties