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

    Type Alias GetTokenSilently

    Options for FaableAuthClient.getTokenSilently.

    type GetTokenSilently = {
        appState?: unknown;
        audience?: string;
        queryParams?: { [key: string]: string };
        redirect?: boolean;
        redirectTo?: string;
        returnTo?: string;
        scope?: string;
    }
    Index

    Properties

    appState? audience? queryParams? redirect? redirectTo? returnTo? scope?

    Properties

    appState?: unknown

    Data to carry across the round-trip, like signInWith…({ appState }).

    audience?: string

    Audience (Api identifier) for the access token.

    queryParams?: { [key: string]: string }

    Extra /authorize params merged in as-is. prompt is always none.

    redirect?: boolean

    false never navigates: when the refresh is refused the call resolves with an AuthLoginRequiredError instead of starting the prompt=none round-trip. Defaults to true in a browser.

    redirectTo?: string

    Where the prompt=none round-trip lands (the OAuth redirect_uri). Defaults to the client's redirectUri, then window.location.origin. Keep it a clean URL: the user's actual location travels as returnTo.

    returnTo?: string

    Where the app should put the user back after the round-trip. Comes back as returnTo in the FaableAuthClient.initialize result — never in the URL. Defaults to the current window.location.href.

    scope?: string

    Scope for the token, when different from the client's default.

    Settings

    Member Visibility

    On This Page

    Properties