docs/interfaces/management.Management.EventStreamCloudEventConnectionCreatedObject4Options.html
Options for the 'adfs' connection
interface EventStreamCloudEventConnectionCreatedObject4Options {
adfs_server?: string;
cert_rollover_notification?: string;
domain_aliases?: string[];
entityId?: string;
fedMetadataXml?: string;
icon_url?: string;
non_persistent_attrs?: string[];
prev_thumbprints?: string[];
set_user_root_attributes?: Management.EventStreamCloudEventConnectionCreatedObject4OptionsSetUserRootAttributesEnum;
should_trust_email_verified_connection?: Management.EventStreamCloudEventConnectionCreatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum;
signInEndpoint?: string;
tenant_domain?: string;
thumbprints?: string[];
upstream_params?: EventStreamCloudEventConnectionCreatedObject4OptionsUpstreamParams;
user_id_attribute?: string;
}
adfs_server?cert_rollover_notification?domain_aliases?entityId?fedMetadataXml?icon_url?non_persistent_attrs?prev_thumbprints?set_user_root_attributes?should_trust_email_verified_connection?signInEndpoint?tenant_domain?thumbprints?upstream_params?user_id_attribute?
Optionaladfs_serveradfs_server?: string
ADFS federation metadata host or XML URL used to discover WS-Fed endpoints and certificates. Errors if adfs_server and fedMetadataXml are both absent.
Optionalcert_rollover_notificationcert_rollover_notification?: string
Timestamp of the last certificate expiring soon notification.
Optionaldomain_aliasesdomain_aliases?: string[]
Email domains associated with this connection for Home Realm Discovery (HRD). When a user's email matches one of these domains, they are automatically routed to this connection during authentication.
OptionalentityIdentityId?: string
The entity identifier (Issuer) for the ADFS Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'.
OptionalfedMetadataXmlfedMetadataXml?: string
Inline XML alternative to 'adfs_server'. Cannot be set together with 'adfs_server'.
Optionalicon_urlicon_url?: string
URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows.
Optionalnon_persistent_attrsnon_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)
Optionalprev_thumbprintsprev_thumbprints?: string[]
Array of certificate thumbprints (SHA-128/SHA-256/SHA-512 hex hashes) for validating SAML signatures. Used with WS-Federation protocol. Maximum 20 thumbprints. Each thumbprint must be a hexadecimal string.
Optionalset_user_root_attributesset_user_root_attributes?: Management.EventStreamCloudEventConnectionCreatedObject4OptionsSetUserRootAttributesEnum
Optionalshould_trust_email_verified_connectionshould_trust_email_verified_connection?: Management.EventStreamCloudEventConnectionCreatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum
OptionalsignInEndpointsignInEndpoint?: string
Passive Requestor (WS-Fed) sign-in endpoint discovered from metadata or provided explicitly.
Optionaltenant_domaintenant_domain?: string
Tenant domain
Optionalthumbprintsthumbprints?: string[]
Array of certificate thumbprints (SHA-128/SHA-256/SHA-512 hex hashes) for validating SAML signatures. Used with WS-Federation protocol. Maximum 20 thumbprints. Each thumbprint must be a hexadecimal string.
Optionalupstream_paramsupstream_params?: EventStreamCloudEventConnectionCreatedObject4OptionsUpstreamParams
Optionaluser_id_attributeuser_id_attribute?: string
Custom ADFS claim to use as the unique user identifier. When provided, this attribute is prepended to the default user_id mapping list with highest priority. Accepts a string (single ADFS claim name).
Member Visibility
ThemeOSLightDark
Properties adfs_servercert_rollover_notificationdomain_aliasesentityIdfedMetadataXmlicon_urlnon_persistent_attrsprev_thumbprintsset_user_root_attributesshould_trust_email_verified_connectionsignInEndpointtenant_domainthumbprintsupstream_paramsuser_id_attribute