Auth0 Node.js SDK - v5.3.0
    Preparing search index...

    Interface ConnectionOptionsOAuth2

    Options for the 'oauth2' connection

    interface ConnectionOptionsOAuth2 {
        non_persistent_attrs?: ConnectionNonPersistentAttrs;
        authParams?: ConnectionAuthParamsOAuth2;
        authParamsMap?: ConnectionAuthParamsMap;
        authorizationURL?: string;
        client_id?: string;
        client_secret?: string;
        customHeaders?: ConnectionCustomHeadersOAuth2;
        fieldsMap?: ConnectionFieldsMap;
        icon_url?: string;
        logoutUrl?: string;
        pkce_enabled?: boolean;
        scope?: ConnectionScopeOAuth2;
        scripts?: ConnectionScriptsOAuth2;
        set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
        tokenURL?: string;
        upstream_params?: ConnectionUpstreamParams;
        useOauthSpecScope?: boolean;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any

      Accepts any additional properties

    Index

    Properties

    non_persistent_attrs? authParams? authParamsMap? authorizationURL? client_id? client_secret? customHeaders? fieldsMap? icon_url? logoutUrl? pkce_enabled? scope? scripts? set_user_root_attributes? tokenURL? upstream_params? useOauthSpecScope?

    Properties

    non_persistent_attrs?: ConnectionNonPersistentAttrs
    authParams?: ConnectionAuthParamsOAuth2
    authParamsMap?: ConnectionAuthParamsMap
    authorizationURL?: string
    client_id?: string
    client_secret?: string
    customHeaders?: ConnectionCustomHeadersOAuth2
    fieldsMap?: ConnectionFieldsMap
    icon_url?: string
    logoutUrl?: string
    pkce_enabled?: boolean

    When true, enables Proof Key for Code Exchange (PKCE) for the authorization code flow. PKCE provides additional security by preventing authorization code interception attacks.

    scope?: ConnectionScopeOAuth2
    scripts?: ConnectionScriptsOAuth2
    set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum
    tokenURL?: string
    upstream_params?: ConnectionUpstreamParams
    useOauthSpecScope?: boolean

    When true, uses space-delimited scopes (per OAuth 2.0 spec) instead of comma-delimited when calling the identity provider's authorization endpoint. Only relevant when using the connection_scope parameter. See https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp#pass-scopes-to-authorize-endpoint

    Settings

    Member Visibility

    On This Page

    Properties