docs/interfaces/management.Management.EventStreamCloudEventConnectionDeletedObject3Options.html
Options for the 'pingfederate' connection
interface EventStreamCloudEventConnectionDeletedObject3Options {
assertion_decryption_settings?: EventStreamCloudEventConnectionDeletedObject3OptionsAssertionDecryptionSettings;
cert?: string;
cert_rollover_notification?: string;
digestAlgorithm?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsDigestAlgorithmEnum;
domain_aliases?: string[];
entityId?: string;
expires?: string;
icon_url?: string;
idpinitiated?: EventStreamCloudEventConnectionDeletedObject3OptionsIdpinitiated;
non_persistent_attrs?: string[];
protocolBinding?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsProtocolBindingEnum;
set_user_root_attributes?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsSetUserRootAttributesEnum;
signatureAlgorithm?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsSignatureAlgorithmEnum;
signInEndpoint?: string;
signingCert?: string;
signSAMLRequest?: boolean;
subject?: EventStreamCloudEventConnectionDeletedObject3OptionsSubject;
tenant_domain?: string;
thumbprints?: string[];
upstream_params?: EventStreamCloudEventConnectionDeletedObject3OptionsUpstreamParams;
pingFederateBaseUrl: string;
}
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
Optionalassertion_decryption_settingsassertion_decryption_settings?: EventStreamCloudEventConnectionDeletedObject3OptionsAssertionDecryptionSettings
Optionalcertcert?: 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.
Optionalcert_rollover_notificationcert_rollover_notification?: string
Timestamp of the last certificate expiring soon notification.
OptionaldigestAlgorithmdigestAlgorithm?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsDigestAlgorithmEnum
Optionaldomain_aliasesdomain_aliases?: string[]
Domain aliases for the connection
OptionalentityIdentityId?: 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.
Optionalexpiresexpires?: string
ISO 8601 formatted datetime indicating when the identity provider's signing certificate expires.
Optionalicon_urlicon_url?: string
URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows.
Optionalidpinitiatedidpinitiated?: EventStreamCloudEventConnectionDeletedObject3OptionsIdpinitiated
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)
OptionalprotocolBindingprotocolBinding?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsProtocolBindingEnum
Optionalset_user_root_attributesset_user_root_attributes?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsSetUserRootAttributesEnum
OptionalsignatureAlgorithmsignatureAlgorithm?: Management.EventStreamCloudEventConnectionDeletedObject3OptionsSignatureAlgorithmEnum
OptionalsignInEndpointsignInEndpoint?: 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.
OptionalsigningCertsigningCert?: 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.
OptionalsignSAMLRequestsignSAMLRequest?: 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).
Optionalsubjectsubject?: EventStreamCloudEventConnectionDeletedObject3OptionsSubject
Optionaltenant_domaintenant_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.
Optionalthumbprintsthumbprints?: 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.
Optionalupstream_paramsupstream_params?: EventStreamCloudEventConnectionDeletedObject3OptionsUpstreamParams
pingFederateBaseUrl: string
URL provided by PingFederate which returns information used for creating the connection
Member Visibility
ThemeOSLightDark
Properties assertion_decryption_settingscertcert_rollover_notificationdigestAlgorithmdomain_aliasesentityIdexpiresicon_urlidpinitiatednon_persistent_attrsprotocolBindingset_user_root_attributessignatureAlgorithmsignInEndpointsigningCertsignSAMLRequestsubjecttenant_domainthumbprintsupstream_paramspingFederateBaseUrl