• management
• Management
• EventStreamCloudEventConnectionUpdatedObject5Options

Interface EventStreamCloudEventConnectionUpdatedObject5Options

Options for the 'ad' connection

interface EventStreamCloudEventConnectionUpdatedObject5Options {
agentIP?: string;
agentMode?: boolean;
agentVersion?: string;
brute_force_protection?: boolean;
certAuth?: boolean;
certs?: string[];
disable_cache?: boolean;
disable_self_service_change_password?: boolean;
domain_aliases?: string[];
icon_url?: string;
ips?: string[];
kerberos?: boolean;
non_persistent_attrs?: string[];
set_user_root_attributes?: Management.EventStreamCloudEventConnectionUpdatedObject5OptionsSetUserRootAttributesEnum;
signInEndpoint?: string;
tenant_domain?: string;
thumbprints?: string[];
upstream_params?: EventStreamCloudEventConnectionUpdatedObject5OptionsUpstreamParams;
}

Index

Properties

agentIP?agentMode?agentVersion?brute_force_protection?certAuth?certs?disable_cache?disable_self_service_change_password?domain_aliases?icon_url?ips?kerberos?non_persistent_attrs?set_user_root_attributes?signInEndpoint?tenant_domain?thumbprints?upstream_params?

Properties

OptionalagentIP

agentIP?: string

IP address of the AD connector agent used to validate that authentication requests originate from the corporate network for Kerberos authentication (managed by the AD Connector agent).

OptionalagentMode

agentMode?: boolean

When enabled, allows direct username/password authentication through the AD connector agent instead of WS-Federation protocol (managed by the AD Connector agent).

OptionalagentVersion

agentVersion?: string

Version identifier of the installed AD connector agent software (managed by the AD Connector agent).

Optionalbrute_force_protection

brute_force_protection?: boolean

Enables Auth0's brute force protection to prevent credential stuffing attacks. When enabled, blocks suspicious login attempts from specific IP addresses after repeated failures.

OptionalcertAuth

certAuth?: boolean

Enables client SSL certificate authentication for the AD connector, requiring HTTPS on the sign-in endpoint

Optionalcerts

certs?: string[]

Array of X.509 certificates in PEM format used for validating SAML signatures from the AD identity provider (managed by the AD Connector agent).

Optionaldisable_cache

disable_cache?: boolean

When enabled, disables caching of AD connector authentication results to ensure real-time validation against the directory

Optionaldisable_self_service_change_password

disable_self_service_change_password?: boolean

When enabled, hides the 'Forgot Password' link on login pages to prevent users from initiating self-service password resets

Optionaldomain_aliases

domain_aliases?: string[]

List of domain names that can be used with identifier-first authentication flow to route users to this AD connection; each domain must be a valid DNS name up to 256 characters

Optionalicon_url

icon_url?: string

https url of the icon to be shown

Optionalips

ips?: string[]

Array of IP address ranges in CIDR notation used to determine if authentication requests originate from the corporate network for Kerberos or certificate authentication.

Optionalkerberos

kerberos?: boolean

Enables Windows Integrated Authentication (Kerberos) for seamless SSO when users authenticate from within the corporate network IP ranges

Optionalnon_persistent_attrs

non_persistent_attrs?: string[]

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

Optionalset_user_root_attributes

set_user_root_attributes?: Management.EventStreamCloudEventConnectionUpdatedObject5OptionsSetUserRootAttributesEnum

OptionalsignInEndpoint

signInEndpoint?: string

The sign-in endpoint type for the AD-LDAP connector agent (managed by the AD Connector agent).

Optionaltenant_domain

tenant_domain?: string

Primary AD domain hint used for HRD and discovery.

Optionalthumbprints

thumbprints?: string[]

Array of certificate SHA-1 thumbprints for validating signatures. Managed by Auth0 when using the AD Connector agent.

Optionalupstream_params

upstream_params?: EventStreamCloudEventConnectionUpdatedObject5OptionsUpstreamParams

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties agentIPagentModeagentVersionbrute_force_protectioncertAuthcertsdisable_cachedisable_self_service_change_passworddomain_aliasesicon_urlipskerberosnon_persistent_attrsset_user_root_attributessignInEndpointtenant_domainthumbprintsupstream_params