• management
• Management
• ConnectionOptionsOAuth2

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)

• ConnectionOptionsCommon
  • ConnectionOptionsOAuth2

Indexable

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

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

OptionalauthParams

authParams?: ConnectionAuthParamsOAuth2

OptionalauthParamsMap

authParamsMap?: ConnectionAuthParamsMap

OptionalauthorizationURL

authorizationURL?: string

Optionalclient_id

client_id?: string

Optionalclient_secret

client_secret?: string

OptionalcustomHeaders

customHeaders?: ConnectionCustomHeadersOAuth2

OptionalfieldsMap

fieldsMap?: ConnectionFieldsMap

Optionalicon_url

icon_url?: string

OptionallogoutUrl

logoutUrl?: string

Optionalpkce_enabled

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.

Optionalscope

scope?: ConnectionScopeOAuth2

Optionalscripts

scripts?: ConnectionScriptsOAuth2

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

OptionaltokenURL

tokenURL?: string

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

OptionaluseOauthSpecScope

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

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties non_persistent_attrsauthParamsauthParamsMapauthorizationURLclient_idclient_secretcustomHeadersfieldsMapicon_urllogoutUrlpkce_enabledscopescriptsset_user_root_attributestokenURLupstream_paramsuseOauthSpecScope