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

    Interface EventStreamCloudEventConnectionCreatedObject3Options

    Options for the 'pingfederate' connection

    interface EventStreamCloudEventConnectionCreatedObject3Options {
        assertion_decryption_settings?: EventStreamCloudEventConnectionCreatedObject3OptionsAssertionDecryptionSettings;
        cert?: string;
        cert_rollover_notification?: string;
        digestAlgorithm?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsDigestAlgorithmEnum;
        domain_aliases?: string[];
        entityId?: string;
        expires?: string;
        icon_url?: string;
        idpinitiated?: EventStreamCloudEventConnectionCreatedObject3OptionsIdpinitiated;
        non_persistent_attrs?: string[];
        protocolBinding?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsProtocolBindingEnum;
        set_user_root_attributes?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsSetUserRootAttributesEnum;
        signatureAlgorithm?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsSignatureAlgorithmEnum;
        signInEndpoint?: string;
        signingCert?: string;
        signSAMLRequest?: boolean;
        subject?: EventStreamCloudEventConnectionCreatedObject3OptionsSubject;
        tenant_domain?: string;
        thumbprints?: string[];
        upstream_params?: EventStreamCloudEventConnectionCreatedObject3OptionsUpstreamParams;
        pingFederateBaseUrl: string;
    }
    Index

    Properties

    assertion_decryption_settings? cert? cert_rollover_notification? digestAlgorithm? domain_aliases? entityId? expires? icon_url? idpinitiated? non_persistent_attrs? protocolBinding? set_user_root_attributes? signatureAlgorithm? signInEndpoint? signingCert? signSAMLRequest? subject? tenant_domain? thumbprints? upstream_params? pingFederateBaseUrl

    Properties

    assertion_decryption_settings?: EventStreamCloudEventConnectionCreatedObject3OptionsAssertionDecryptionSettings
    cert?: string

    X.509 signing certificate from the identity provider in .der format. Used to validate signatures in SAML Responses and Assertions. This is an alternative to signingCert and is kept for backward compatibility. Prefer using signingCert instead.

    cert_rollover_notification?: string

    Timestamp of the last certificate expiring soon notification.

    digestAlgorithm?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsDigestAlgorithmEnum
    domain_aliases?: string[]

    Domain aliases for the connection

    entityId?: string

    The entity identifier (Issuer) for the SAML Service Provider. When not provided, defaults to 'urn:auth0:{tenant}:{connection}'. This value is included in SAML AuthnRequest messages sent to the identity provider.

    expires?: string

    ISO 8601 formatted datetime indicating when the identity provider's signing certificate expires.

    icon_url?: string

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

    idpinitiated?: EventStreamCloudEventConnectionCreatedObject3OptionsIdpinitiated
    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)

    protocolBinding?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsProtocolBindingEnum
    set_user_root_attributes?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsSetUserRootAttributesEnum
    signatureAlgorithm?: Management.EventStreamCloudEventConnectionCreatedObject3OptionsSignatureAlgorithmEnum
    signInEndpoint?: string

    Identity provider's SAML SingleSignOnService endpoint URL where Auth0 sends SAML authentication requests. This is the primary login URL for the SAML connection. Required unless using metadataUrl or metadataXml.

    signingCert?: string

    Base64-encoded X.509 certificate from the identity provider used to validate signatures in SAML responses and assertions. The certificate is decoded and used for cryptographic signature verification.

    signSAMLRequest?: boolean

    When true, Auth0 signs SAML authentication requests using the connection's signing key. The signature includes the request's digest and is validated by the identity provider. Defaults to false (unsigned requests).

    subject?: EventStreamCloudEventConnectionCreatedObject3OptionsSubject
    tenant_domain?: string

    For SAML connections, the tenant domain used to construct the login endpoint URL. Can be a string for single-tenant or an array of strings for multi-tenant validation.

    thumbprints?: string[]

    SHA-1 thumbprints (fingerprints) of the identity provider's signing certificates. Automatically computed from signingCert during connection creation. Each thumbprint must be a 40-character hexadecimal string.

    upstream_params?: EventStreamCloudEventConnectionCreatedObject3OptionsUpstreamParams
    pingFederateBaseUrl: string

    URL provided by PingFederate which returns information used for creating the connection

    Settings

    Member Visibility

    On This Page

    Properties