Class EventStreamCloudEventConnectionCreatedObject4Options

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

Options for the 'adfs' connection

[Serializable]
public record EventStreamCloudEventConnectionCreatedObject4Options : IJsonOnDeserialized, IEquatable<EventStreamCloudEventConnectionCreatedObject4Options>

Inheritance

object

EventStreamCloudEventConnectionCreatedObject4Options

Implements

IJsonOnDeserialized

IEquatable<EventStreamCloudEventConnectionCreatedObject4Options>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

AdditionalProperties

[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }

Property Value

ReadOnlyAdditionalProperties

AdfsServer

ADFS federation metadata host or XML URL used to discover WS-Fed endpoints and certificates. Errors if adfs_server and fedMetadataXml are both absent.

[JsonPropertyName("adfs_server")]
public string? AdfsServer { 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?

DomainAliases

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.

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

Property Value

IEnumerable<string>

EntityId

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

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

Property Value

string

FedMetadataXml

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

[JsonPropertyName("fedMetadataXml")]
public string? FedMetadataXml { 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

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>

PrevThumbprints

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.

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

Property Value

IEnumerable<string>

SetUserRootAttributes

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

Property Value

EventStreamCloudEventConnectionCreatedObject4OptionsSetUserRootAttributesEnum?

ShouldTrustEmailVerifiedConnection

[JsonPropertyName("should_trust_email_verified_connection")]
public EventStreamCloudEventConnectionCreatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum? ShouldTrustEmailVerifiedConnection { get; set; }

Property Value

EventStreamCloudEventConnectionCreatedObject4OptionsShouldTrustEmailVerifiedConnectionEnum?

SignInEndpoint

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

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

Property Value

string

TenantDomain

Tenant domain

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

Property Value

string

Thumbprints

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.

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

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