Table of Contents

Class ConnectionOptions

Namespace
Auth0.ManagementApi.Models.Connections
Assembly
Auth0.ManagementApi.dll

The connection's options.

public class ConnectionOptions
Inheritance
ConnectionOptions
Inherited Members

Properties

ApiEnableUsers 

[JsonProperty("api_enable_users")]
public bool? ApiEnableUsers { get; set; }

Property Value

bool?

Attributes

Attribute Configuration

[JsonProperty("attributes")]
public ConnectionOptionsAttributes Attributes { get; set; }

Property Value

ConnectionOptionsAttributes

AuthenticationMethods

Options for enabling authentication methods.

[JsonProperty("authentication_methods")]
public ConnectionOptionsAuthenticationMethods AuthenticationMethods { get; set; }

Property Value

ConnectionOptionsAuthenticationMethods

BasicProfile 

[JsonProperty("basic_profile")]
public bool? BasicProfile { get; set; }

Property Value

bool?

CustomScripts

A map of scripts used to integrate with a custom database.

[JsonProperty("customScripts")]
public ConnectionOptionsCustomScripts CustomScripts { get; set; }

Property Value

ConnectionOptionsCustomScripts

DisableSelfServiceChangePassword 

[JsonProperty("disable_self_service_change_password")]
public bool? DisableSelfServiceChangePassword { get; set; }

Property Value

bool?

EnableDatabaseCustomization

Set to true to use a legacy user store

[JsonProperty("enabledDatabaseCustomization")]
public bool? EnableDatabaseCustomization { get; set; }

Property Value

bool?

EnableScriptContext 

[JsonProperty("enable_script_context")]
public bool? EnableScriptContext { get; set; }

Property Value

bool?

ExtAdmin 

[JsonProperty("ext_admin")]
public bool? ExtAdmin { get; set; }

Property Value

bool?

ExtAgreedTerms 

[JsonProperty("ext_agreed_terms")]
public bool? ExtAgreedTerms { get; set; }

Property Value

bool?

ExtAssignedPlans 

[JsonProperty("ext_assigned_plans")]
public bool? ExtAssignedPlans { get; set; }

Property Value

bool?

ExtGroups 

[JsonProperty("ext_groups")]
public bool? ExtGroups { get; set; }

Property Value

bool?

ExtIsSuspended 

[JsonProperty("ext_is_suspended")]
public bool? ExtIsSuspended { get; set; }

Property Value

bool?

ExtProfile 

[JsonProperty("ext_profile")]
public bool? ExtProfile { get; set; }

Property Value

bool?

GatewayAuthentication

When using an external IdP, this flag determines whether 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes are updated. In addition, it also determines whether the user is created when user doesnt exist previously. Possible values are 'on_each_login' (default value, it configures the connection to automatically create the user if necessary and update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on_first_login' (configures the connection to create the user and set the root attributes on first login only, allowing them to be independently updated thereafter), and 'never_on_login' (configures the connection not to create the user and not to set the root attributes from the external IdP, allowing them to be independently updated).

[JsonProperty("gateway_authentication")]
public GatewayAuthentication GatewayAuthentication { get; set; }

Property Value

GatewayAuthentication

ImportMode

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

[JsonProperty("import_mode")]
public bool? ImportMode { get; set; }

Property Value

bool?

NonPersistentAttributes

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

[JsonProperty("non_persistent_attrs")]
public string[] NonPersistentAttributes { get; set; }

Property Value

string[]

PasskeyOptions

Options for the passkey authentication method

[JsonProperty("passkey_options")]
public ConnectionOptionsPasskeyOptions PasskeyOptions { get; set; }

Property Value

ConnectionOptionsPasskeyOptions

PasswordComplexityOptions

Password complexity options

[JsonProperty("password_complexity_options")]
public ConnectionOptionsPasswordComplexityOptions PasswordComplexityOptions { get; set; }

Property Value

ConnectionOptionsPasswordComplexityOptions

PasswordDictionary

Options for personal info in passwords policy

[JsonProperty("password_dictionary")]
public ConnectionOptionsPasswordDictionary PasswordDictionary { get; set; }

Property Value

ConnectionOptionsPasswordDictionary

PasswordHistory

Options for password history policy

[JsonProperty("password_history")]
public ConnectionOptionsPasswordHistory PasswordHistory { get; set; }

Property Value

ConnectionOptionsPasswordHistory

PasswordNoPersonalInfo

Options for personal info in passwords policy

[JsonProperty("password_no_personal_info")]
public ConnectionOptionsPasswordNoPersonalInfo PasswordNoPersonalInfo { get; set; }

Property Value

ConnectionOptionsPasswordNoPersonalInfo

PasswordPolicy

Password strength level

[JsonProperty("passwordPolicy")]
[JsonConverter(typeof(StringEnumConverter))]
public ConnectionOptionsPasswordPolicy? PasswordPolicy { get; set; }

Property Value

ConnectionOptionsPasswordPolicy?

Precedence

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

[JsonProperty("precedence", ItemConverterType = typeof(StringEnumConverter))]
public ConnectionOptionsPrecedence[] Precedence { get; set; }

Property Value

ConnectionOptionsPrecedence[]

SetUserRootAttributes

When using an external IdP, this flag determines whether 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes are updated. In addition, it also determines whether the user is created when user doesnt exist previously. Possible values are 'on_each_login' (default value, it configures the connection to automatically create the user if necessary and update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on_first_login' (configures the connection to create the user and set the root attributes on first login only, allowing them to be independently updated thereafter), and 'never_on_login' (configures the connection not to create the user and not to set the root attributes from the external IdP, allowing them to be independently updated).

[JsonProperty("set_user_root_attributes")]
[JsonConverter(typeof(StringEnumConverter))]
public SetUserRootAttributes? SetUserRootAttributes { get; set; }

Property Value

SetUserRootAttributes?

UpstreamParams

Options for adding parameters in the request to the upstream IdP

[JsonProperty("upstream_params")]
public dynamic UpstreamParams { get; set; }

Property Value

dynamic

Validation

Options for validation

[JsonProperty("validation")]
public ConnectionOptionsValidation Validation { get; set; }

Property Value

ConnectionOptionsValidation