Table of Contents

Class EventStreamCloudEventConnectionCreatedObject2Options

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll

Options for the 'samlp' connection

[Serializable]
public record EventStreamCloudEventConnectionCreatedObject2Options : IJsonOnDeserialized, IEquatable<EventStreamCloudEventConnectionCreatedObject2Options>
Inheritance
EventStreamCloudEventConnectionCreatedObject2Options
Implements
Inherited Members
Extension Methods

Properties

AdditionalProperties 

[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }

Property Value

ReadOnlyAdditionalProperties

AssertionDecryptionSettings 

[JsonPropertyName("assertion_decryption_settings")]
public EventStreamCloudEventConnectionCreatedObject2OptionsAssertionDecryptionSettings? AssertionDecryptionSettings { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsAssertionDecryptionSettings

Cert

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.

[JsonPropertyName("cert")]
public string? Cert { get; set; }

Property Value

string

CertRolloverNotification

Timestamp of the last certificate expiring soon notification.

[JsonPropertyName("cert_rollover_notification")]
public DateTime? CertRolloverNotification { get; set; }

Property Value

DateTime?

Debug

When true, enables detailed SAML debugging by issuing 'w' (warning) events in tenant logs containing SAML request/response details. WARNING: Potentially exposes sensitive user information (PII, credentials) and should only be enabled temporarily for debugging purposes.

[JsonPropertyName("debug")]
public bool? Debug { get; set; }

Property Value

bool?

Deflate

When true, enables DEFLATE compression for SAML requests sent via HTTP-Redirect binding.

[JsonPropertyName("deflate")]
public bool? Deflate { get; set; }

Property Value

bool?

DestinationUrl

The URL where Auth0 will send SAML authentication requests (the Identity Provider's SSO URL). Must be a valid HTTPS URL.

[JsonPropertyName("destinationUrl")]
public string? DestinationUrl { get; set; }

Property Value

string

DigestAlgorithm 

[JsonPropertyName("digestAlgorithm")]
public EventStreamCloudEventConnectionCreatedObject2OptionsDigestAlgorithmEnum? DigestAlgorithm { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsDigestAlgorithmEnum?

DisableSignout

When true, disables sending SAML logout requests (SingleLogoutService) to the identity provider during user sign-out. The user will be logged out of Auth0 but will remain logged into the identity provider. Defaults to false (federated logout enabled).

[JsonPropertyName("disableSignout")]
public bool? DisableSignout { get; set; }

Property Value

bool?

DomainAliases

Domain aliases for the connection

[JsonPropertyName("domain_aliases")]
public IEnumerable<string>? DomainAliases { get; set; }

Property Value

IEnumerable<string>

EntityId

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.

[JsonPropertyName("entityId")]
public string? EntityId { get; set; }

Property Value

string

Expires

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

[JsonPropertyName("expires")]
public DateTime? Expires { get; set; }

Property Value

DateTime?

FieldsMap 

[JsonPropertyName("fieldsMap")]
public Dictionary<string, object?>? FieldsMap { get; set; }

Property Value

Dictionary<string, object>

GlobalTokenRevocationJwtIss

Expected 'iss' (Issuer) claim value for JWT tokens in Global Token Revocation requests from the identity provider. When configured, Auth0 validates the JWT issuer matches this value before processing token revocation. Must be used together with global_token_revocation_jwt_sub.

[JsonPropertyName("global_token_revocation_jwt_iss")]
public string? GlobalTokenRevocationJwtIss { get; set; }

Property Value

string

GlobalTokenRevocationJwtSub

Expected 'sub' (Subject) claim value for JWT tokens in Global Token Revocation requests from the identity provider. When configured, Auth0 validates the JWT subject matches this value before processing token revocation. Must be used together with global_token_revocation_jwt_iss.

[JsonPropertyName("global_token_revocation_jwt_sub")]
public string? GlobalTokenRevocationJwtSub { get; set; }

Property Value

string

IconUrl

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

[JsonPropertyName("icon_url")]
public string? IconUrl { get; set; }

Property Value

string

Idpinitiated 

[JsonPropertyName("idpinitiated")]
public EventStreamCloudEventConnectionCreatedObject2OptionsIdpinitiated? Idpinitiated { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsIdpinitiated

MetadataUrl

HTTPS URL to the identity provider's SAML metadata document. When provided, Auth0 automatically fetches and parses the metadata to extract signInEndpoint, signOutEndpoint, signingCert, signSAMLRequest, and protocolBinding. Use metadataUrl OR metadataXml, not both.

[JsonPropertyName("metadataUrl")]
public string? MetadataUrl { get; set; }

Property Value

string

NonPersistentAttrs

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

[JsonPropertyName("non_persistent_attrs")]
public IEnumerable<string>? NonPersistentAttrs { get; set; }

Property Value

IEnumerable<string>

ProtocolBinding 

[JsonPropertyName("protocolBinding")]
public EventStreamCloudEventConnectionCreatedObject2OptionsProtocolBindingEnum? ProtocolBinding { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsProtocolBindingEnum?

RecipientUrl

The URL where Auth0 will send SAML authentication requests (the Identity Provider's SSO URL). Must be a valid HTTPS URL.

[JsonPropertyName("recipientUrl")]
public string? RecipientUrl { get; set; }

Property Value

string

RequestTemplate

Custom XML template for SAML authentication requests. Supports variable substitution using @@variableName@@ syntax. When not provided, uses default SAML AuthnRequest template. See https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/configure-auth0-saml-service-provider#customize-the-request-template

[JsonPropertyName("requestTemplate")]
public string? RequestTemplate { get; set; }

Property Value

string

SetUserRootAttributes 

[JsonPropertyName("set_user_root_attributes")]
public EventStreamCloudEventConnectionCreatedObject2OptionsSetUserRootAttributesEnum? SetUserRootAttributes { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsSetUserRootAttributesEnum?

SignInEndpoint

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.

[JsonPropertyName("signInEndpoint")]
public string? SignInEndpoint { get; set; }

Property Value

string

SignOutEndpoint

Identity provider's SAML SingleLogoutService endpoint URL where Auth0 sends logout requests for federated sign-out. When not provided, defaults to signInEndpoint. Only used if disableSignout is false.

[JsonPropertyName("signOutEndpoint")]
public string? SignOutEndpoint { get; set; }

Property Value

string

SignSamlRequest

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

[JsonPropertyName("signSAMLRequest")]
public bool? SignSamlRequest { get; set; }

Property Value

bool?

SignatureAlgorithm 

[JsonPropertyName("signatureAlgorithm")]
public EventStreamCloudEventConnectionCreatedObject2OptionsSignatureAlgorithmEnum? SignatureAlgorithm { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsSignatureAlgorithmEnum?

SigningCert

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.

[JsonPropertyName("signingCert")]
public string? SigningCert { get; set; }

Property Value

string

Subject 

[JsonPropertyName("subject")]
public EventStreamCloudEventConnectionCreatedObject2OptionsSubject? Subject { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject2OptionsSubject

TenantDomain

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.

[JsonPropertyName("tenant_domain")]
public string? TenantDomain { get; set; }

Property Value

string

Thumbprints

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.

[JsonPropertyName("thumbprints")]
public IEnumerable<string>? Thumbprints { get; set; }

Property Value

IEnumerable<string>

UpstreamParams 

[JsonPropertyName("upstream_params")]
public Dictionary<string, object?>? UpstreamParams { get; set; }

Property Value

Dictionary<string, object>

UserIdAttribute

Custom SAML assertion attribute 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 SAML attribute name).

[JsonPropertyName("user_id_attribute")]
public string? UserIdAttribute { get; set; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.