@faable/auth-js - v2.1.0
    Preparing search index...

    Type Alias SignOut

    Options accepted by FaableAuthClient.signOut.

    Logout

    type SignOut = {
        redirect?: boolean;
        returnTo?: string;
        scope?: "global" | "local" | "others";
    }
    Index

    Properties

    redirect?: boolean

    Whether to end the session with a top-level navigation to the auth server's /logout (RP-initiated logout). Defaults to true for the global scope in a browser.

    This is required to clear the auth server's SSO cookie: it lives on the auth domain, so a cross-origin fetch from your app can neither send nor clear it. Without the navigation the SSO session survives and the next /authorize silently re-logs the previous user, ignoring the requested connection.

    Set to false to keep the legacy behaviour (clear local storage + a best-effort cross-origin fetch to /logout) — e.g. when your app and the auth server share a site, or you drive the navigation yourself with FaableAuthClient.getLogoutUrl. Ignored for the local/others scopes and outside the browser.

    returnTo?: string

    Where the auth server should send the browser back to after logging out, mapped to the OIDC post_logout_redirect_uri. Must be registered as a logout URL on the client or the server responds 400. Only used on the redirect path.

    scope?: "global" | "local" | "others"

    Which sessions to log out.

    • 'global' — every refresh token for the user (default)
    • 'local' — only this client's storage
    • 'others' — every other session except this device's; no SIGNED_OUT event is fired locally