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

    Type Alias SignInWithOAuthConnection

    Options accepted by FaableAuthClient.signInWithOauthConnection.

    Connections

    type SignInWithOAuthConnection = {
        appState?: unknown;
        audience?: string;
        connection?: string;
        connection_id?: string;
        queryParams?: { [key: string]: string };
        redirectTo?: string;
        returnTo?: string;
        scopes?: string;
        skipBrowserRedirect?: boolean;
    }
    Index

    Properties

    appState? audience? connection? connection_id? queryParams? redirectTo? returnTo? scopes? skipBrowserRedirect?

    Properties

    appState?: unknown

    Cualquier valor serializable que la app quiera recuperar al volver del login (el número de curso que estaba comprando, el formulario a medio rellenar, de dónde venía). Se guarda en el navegador, junto al verifier de PKCE: no viaja en la URL y el servidor no lo ve nunca.

    Vuelve ya deserializado en appState, en el resultado de FaableAuthClient.handleRedirectCallback / FaableAuthClient.initialize.

    Prefiérelo a meter tus datos en queryParams.state: ese parámetro es del protocolo, viaja por la URL y se queda en el historial.

    audience?: string

    Override the API audience the issued access token should be bound to. Falls back to FaableAuthClientConfig.audience when omitted.

    connection?: string

    Default connection is used if not setted. Kept for compatibility with tenants using connection names.

    connection_id?: string

    Identifier of the connection to use. Preferred over connection when known, as the backend resolves it without additional lookups. If both are provided, connection_id wins.

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

    An object of query params

    redirectTo?: string

    A URL to send the user to after they are confirmed.

    returnTo?: string

    App-side destination to return the user to once the callback has been processed. It is stored locally alongside the PKCE verifier (never sent to the server) and surfaced back as returnTo on the result of FaableAuthClient.handleRedirectCallback / FaableAuthClient.initialize.

    scopes?: string

    A space-separated list of scopes granted to the OAuth application.

    skipBrowserRedirect?: boolean

    If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider.

    Settings

    Member Visibility

    On This Page

    Properties