Auth0 Node.js SDK - v6.0.0
    Preparing search index...

    Interface EventStreamCloudEventConnectionUpdatedObject4Options

    Options for the 'adfs' connection

    interface EventStreamCloudEventConnectionUpdatedObject4Options {
        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.EventStreamCloudEventConnectionUpdatedObject4OptionsSetUserRootAttributesEnum;
        should_trust_email_verified_connection?: Management.EventStreamCloudEventConnectionUpdatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum;
        signInEndpoint?: string;
        tenant_domain?: string;
        thumbprints?: string[];
        upstream_params?: EventStreamCloudEventConnectionUpdatedObject4OptionsUpstreamParams;
        user_id_attribute?: string;
    }
    Index

    Properties

    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?

    Properties

    adfs_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.

    cert_rollover_notification?: string

    Timestamp of the last certificate expiring soon notification.

    domain_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.

    entityId?: string

    The entity identifier (Issuer) for the ADFS Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'.

    fedMetadataXml?: string

    Inline XML alternative to 'adfs_server'. Cannot be set together with 'adfs_server'.

    icon_url?: string

    URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows.

    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)

    prev_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.

    set_user_root_attributes?: Management.EventStreamCloudEventConnectionUpdatedObject4OptionsSetUserRootAttributesEnum
    should_trust_email_verified_connection?: Management.EventStreamCloudEventConnectionUpdatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum
    signInEndpoint?: string

    Passive Requestor (WS-Fed) sign-in endpoint discovered from metadata or provided explicitly.

    tenant_domain?: string

    Tenant domain

    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.

    upstream_params?: EventStreamCloudEventConnectionUpdatedObject4OptionsUpstreamParams
    user_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).

    Settings

    Member Visibility

    On This Page

    Properties