Auth0 · Schema
ConnectionPropertiesOptions
The connection's options (depend on the connection strategy)
AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
Properties
| Name | Type | Description |
|---|---|---|
| validation | object | |
| non_persistent_attrs | arraynull | An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist) |
| precedence | array | Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used. |
| attributes | object | |
| enable_script_context | boolean | Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled) |
| enabledDatabaseCustomization | boolean | Set to true to use a legacy user store |
| 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 |
| configuration | objectnull | Stores encrypted string only configurations for connections |
| customScripts | object | |
| authentication_methods | object | |
| passkey_options | object | |
| passwordPolicy | object | |
| password_complexity_options | object | |
| password_history | object | |
| password_no_personal_info | object | |
| password_dictionary | object | |
| 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 | object | |
| set_user_root_attributes | object | |
| gateway_authentication | object | |
| federated_connections_access_tokens | object | |
| password_options | object | |
| assertion_decryption_settings | object | |
| id_token_signed_response_algs | object | |
| token_endpoint_auth_method | object | |
| token_endpoint_auth_signing_alg | object | |
| token_endpoint_jwtca_aud_format | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ConnectionPropertiesOptions",
"title": "ConnectionPropertiesOptions",
"type": "object",
"description": "The connection's options (depend on the connection strategy)",
"additionalProperties": true,
"properties": {
"validation": {
"$ref": "#/components/schemas/ConnectionValidationOptions"
},
"non_persistent_attrs": {
"type": [
"array",
"null"
],
"description": "An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist)",
"items": {
"type": "string"
}
},
"precedence": {
"type": "array",
"description": "Order of precedence for attribute types. If the property is not specified, the default precedence of attributes will be used.",
"minItems": 3,
"items": {
"$ref": "#/components/schemas/ConnectionIdentifierPrecedenceEnum"
}
},
"attributes": {
"$ref": "#/components/schemas/ConnectionAttributes"
},
"enable_script_context": {
"type": "boolean",
"description": "Set to true to inject context into custom DB scripts (warning: cannot be disabled once enabled)"
},
"enabledDatabaseCustomization": {
"type": "boolean",
"description": "Set to true to use a legacy user store"
},
"import_mode": {
"type": "boolean",
"description": "Enable this if you have a legacy user store and you want to gradually migrate those users to the Auth0 user store"
},
"configuration": {
"type": [
"object",
"null"
],
"description": "Stores encrypted string only configurations for connections",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"customScripts": {
"$ref": "#/components/schemas/ConnectionCustomScripts"
},
"authentication_methods": {
"$ref": "#/components/schemas/ConnectionAuthenticationMethods"
},
"passkey_options": {
"$ref": "#/components/schemas/ConnectionPasskeyOptions"
},
"passwordPolicy": {
"$ref": "#/components/schemas/ConnectionPasswordPolicyEnum"
},
"password_complexity_options": {
"$ref": "#/components/schemas/ConnectionPasswordComplexityOptions"
},
"password_history": {
"$ref": "#/components/schemas/ConnectionPasswordHistoryOptions"
},
"password_no_personal_info": {
"$ref": "#/components/schemas/ConnectionPasswordNoPersonalInfoOptions"
},
"password_dictionary": {
"$ref": "#/components/schemas/ConnectionPasswordDictionaryOptions"
},
"api_enable_users": {
"type": "boolean"
},
"api_enable_groups": {
"type": "boolean",
"x-release-lifecycle": "EA"
},
"basic_profile": {
"type": "boolean"
},
"ext_admin": {
"type": "boolean"
},
"ext_is_suspended": {
"type": "boolean"
},
"ext_agreed_terms": {
"type": "boolean"
},
"ext_groups": {
"type": "boolean"
},
"ext_assigned_plans": {
"type": "boolean"
},
"ext_profile": {
"type": "boolean"
},
"disable_self_service_change_password": {
"type": "boolean"
},
"upstream_params": {
"$ref": "#/components/schemas/ConnectionUpstreamParams"
},
"set_user_root_attributes": {
"$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
},
"gateway_authentication": {
"$ref": "#/components/schemas/ConnectionGatewayAuthentication"
},
"federated_connections_access_tokens": {
"$ref": "#/components/schemas/ConnectionFederatedConnectionsAccessTokens"
},
"password_options": {
"$ref": "#/components/schemas/ConnectionPasswordOptions",
"x-release-lifecycle": "EA"
},
"assertion_decryption_settings": {
"$ref": "#/components/schemas/ConnectionAssertionDecryptionSettings"
},
"id_token_signed_response_algs": {
"$ref": "#/components/schemas/ConnectionIdTokenSignedResponseAlgs"
},
"token_endpoint_auth_method": {
"$ref": "#/components/schemas/ConnectionTokenEndpointAuthMethodEnum"
},
"token_endpoint_auth_signing_alg": {
"$ref": "#/components/schemas/ConnectionTokenEndpointAuthSigningAlgEnum"
},
"token_endpoint_jwtca_aud_format": {
"$ref": "#/components/schemas/ConnectionTokenEndpointJwtcaAudFormatEnumOIDC"
}
}
}