• management
• Management
• UpdateConnectionOptions

Interface UpdateConnectionOptions

The connection's options (depend on the connection strategy). To update these options, the update:connections_options scope must be present. To verify your changes, also include the read:connections_options scope. If this scope is not specified, you will not be able to review the updated object.

interface UpdateConnectionOptions {
validation?: ConnectionValidationOptions | null;
non_persistent_attrs?: string[] | null;
precedence?: Management.ConnectionIdentifierPrecedenceEnum[];
attributes?: ConnectionAttributes;
enable_script_context?: boolean;
enabledDatabaseCustomization?: boolean;
import_mode?: boolean;
configuration?: Record<string, string | null> | null;
customScripts?: ConnectionCustomScripts;
authentication_methods?: ConnectionAuthenticationMethods | null;
passkey_options?: ConnectionPasskeyOptions | null;
passwordPolicy?: Management.ConnectionPasswordPolicyEnum | null;
password_complexity_options?: ConnectionPasswordComplexityOptions | null;
password_history?: ConnectionPasswordHistoryOptions | null;
password_no_personal_info?: ConnectionPasswordNoPersonalInfoOptions | null;
password_dictionary?: ConnectionPasswordDictionaryOptions | null;
api_enable_users?: boolean;
api_enable_groups?: boolean;
basic_profile?: boolean;
ext_admin?: boolean;
ext_is_suspended?: boolean;
ext_agreed_terms?: boolean;
ext_groups?: boolean;
ext_assigned_plans?: boolean;
ext_profile?: boolean;
disable_self_service_change_password?: boolean;
upstream_params?: ConnectionUpstreamParams;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
gateway_authentication?: ConnectionGatewayAuthentication | null;
federated_connections_access_tokens?:
| ConnectionFederatedConnectionsAccessTokens
| null;
password_options?: ConnectionPasswordOptions;
assertion_decryption_settings?: ConnectionAssertionDecryptionSettings;
id_token_signed_response_algs?: ConnectionIdTokenSignedResponseAlgs;
token_endpoint_auth_method?: | Management.ConnectionTokenEndpointAuthMethodEnum
| null;
token_endpoint_auth_signing_alg?: | Management.ConnectionTokenEndpointAuthSigningAlgEnum
| null;
token_endpoint_jwtca_aud_format?: Management.ConnectionTokenEndpointJwtcaAudFormatEnumOidc;
key: string: any;
}

Indexable

Accepts any additional properties

Index

Properties

validation?non_persistent_attrs?precedence?attributes?enable_script_context?enabledDatabaseCustomization?import_mode?configuration?customScripts?authentication_methods?passkey_options?passwordPolicy?password_complexity_options?password_history?password_no_personal_info?password_dictionary?api_enable_users?api_enable_groups?basic_profile?ext_admin?ext_is_suspended?ext_agreed_terms?ext_groups?ext_assigned_plans?ext_profile?disable_self_service_change_password?upstream_params?set_user_root_attributes?gateway_authentication?federated_connections_access_tokens?password_options?assertion_decryption_settings?id_token_signed_response_algs?token_endpoint_auth_method?token_endpoint_auth_signing_alg?token_endpoint_jwtca_aud_format?

Properties

Optionalvalidation

validation?: ConnectionValidationOptions | null

Optionalnon_persistent_attrs

non_persistent_attrs?: string[] | null

An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist)

Optionalprecedence

precedence?: Management.ConnectionIdentifierPrecedenceEnum[]

Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used.

Optionalattributes

attributes?: ConnectionAttributes

Optionalenable_script_context

enable_script_context?: boolean

Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled)

OptionalenabledDatabaseCustomization

enabledDatabaseCustomization?: boolean

Set to true to use a legacy user store

Optionalimport_mode

import_mode?: boolean

Enable this if you have a legacy user store and you want to gradually migrate those users to the Auth0 user store

Optionalconfiguration

configuration?: Record<string, string | null> | null

Stores encrypted string only configurations for connections

OptionalcustomScripts

customScripts?: ConnectionCustomScripts

Optionalauthentication_methods

authentication_methods?: ConnectionAuthenticationMethods | null

Optionalpasskey_options

passkey_options?: ConnectionPasskeyOptions | null

OptionalpasswordPolicy

passwordPolicy?: Management.ConnectionPasswordPolicyEnum | null

Optionalpassword_complexity_options

password_complexity_options?: ConnectionPasswordComplexityOptions | null

Optionalpassword_history

password_history?: ConnectionPasswordHistoryOptions | null

Optionalpassword_no_personal_info

password_no_personal_info?: ConnectionPasswordNoPersonalInfoOptions | null

Optionalpassword_dictionary

password_dictionary?: ConnectionPasswordDictionaryOptions | null

Optionalapi_enable_users

api_enable_users?: boolean

Optionalapi_enable_groups

api_enable_groups?: boolean

Optionalbasic_profile

basic_profile?: boolean

Optionalext_admin

ext_admin?: boolean

Optionalext_is_suspended

ext_is_suspended?: boolean

Optionalext_agreed_terms

ext_agreed_terms?: boolean

Optionalext_groups

ext_groups?: boolean

Optionalext_assigned_plans

ext_assigned_plans?: boolean

Optionalext_profile

ext_profile?: boolean

Optionaldisable_self_service_change_password

disable_self_service_change_password?: boolean

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionalgateway_authentication

gateway_authentication?: ConnectionGatewayAuthentication | null

Optionalfederated_connections_access_tokens

federated_connections_access_tokens?:
| ConnectionFederatedConnectionsAccessTokens
| null

Optionalpassword_options

password_options?: ConnectionPasswordOptions

Optionalassertion_decryption_settings

assertion_decryption_settings?: ConnectionAssertionDecryptionSettings

Optionalid_token_signed_response_algs

id_token_signed_response_algs?: ConnectionIdTokenSignedResponseAlgs

Optionaltoken_endpoint_auth_method

token_endpoint_auth_method?:
| Management.ConnectionTokenEndpointAuthMethodEnum
| null

Optionaltoken_endpoint_auth_signing_alg

token_endpoint_auth_signing_alg?:
| Management.ConnectionTokenEndpointAuthSigningAlgEnum
| null

Optionaltoken_endpoint_jwtca_aud_format

token_endpoint_jwtca_aud_format?: Management.ConnectionTokenEndpointJwtcaAudFormatEnumOidc

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties validationnon_persistent_attrsprecedenceattributesenable_script_contextenabledDatabaseCustomizationimport_modeconfigurationcustomScriptsauthentication_methodspasskey_optionspasswordPolicypassword_complexity_optionspassword_historypassword_no_personal_infopassword_dictionaryapi_enable_usersapi_enable_groupsbasic_profileext_adminext_is_suspendedext_agreed_termsext_groupsext_assigned_plansext_profiledisable_self_service_change_passwordupstream_paramsset_user_root_attributesgateway_authenticationfederated_connections_access_tokenspassword_optionsassertion_decryption_settingsid_token_signed_response_algstoken_endpoint_auth_methodtoken_endpoint_auth_signing_algtoken_endpoint_jwtca_aud_format