@faable/auth-js - v1.7.4
    Preparing search index...

    Type Alias SignInWithOAuthConnection

    Options accepted by FaableAuthClient.signInWithOauthConnection.

    Connections

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

    Properties

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

    Properties

    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.

    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