Class EventStreamCloudEventConnectionUpdatedObject7Options
- Namespace
- Auth0.ManagementApi
- Assembly
- Auth0.ManagementApi.dll
Options for the 'waad' connection
[Serializable]
public record EventStreamCloudEventConnectionUpdatedObject7Options : IJsonOnDeserialized, IEquatable<EventStreamCloudEventConnectionUpdatedObject7Options>
- Inheritance
-
EventStreamCloudEventConnectionUpdatedObject7Options
- Implements
- Inherited Members
- Extension Methods
Properties
AdditionalProperties
[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }
Property Value
ApiEnableUsers
Enable users API
[JsonPropertyName("api_enable_users")]
public bool? ApiEnableUsers { get; set; }
Property Value
- bool?
AppDomain
The Azure AD application domain (e.g., 'contoso.onmicrosoft.com'). Used primarily with WS-Federation protocol and Azure AD v1 endpoints.
[JsonPropertyName("app_domain")]
public string? AppDomain { get; set; }
Property Value
AppId
The Application ID URI (App ID URI) for the Azure AD application. Required when using Azure AD v1 with the Resource Owner Password flow. Used to identify the resource being requested in OAuth token requests.
[JsonPropertyName("app_id")]
public string? AppId { get; set; }
Property Value
BasicProfile
Includes basic user profile information from Azure AD (name, email, given_name, family_name). Always enabled and required - represents the minimum profile data retrieved during authentication.
[JsonPropertyName("basic_profile")]
public bool? BasicProfile { get; set; }
Property Value
- bool?
CertRolloverNotification
Timestamp of the last certificate expiring soon notification.
[JsonPropertyName("cert_rollover_notification")]
public DateTime? CertRolloverNotification { get; set; }
Property Value
ClientId
OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
[JsonPropertyName("client_id")]
public required string ClientId { get; set; }
Property Value
Domain
The primary Azure AD tenant domain (e.g., 'contoso.onmicrosoft.com' or 'contoso.com').
[JsonPropertyName("domain")]
public string? Domain { get; set; }
Property Value
DomainAliases
Alternative domain names associated with this Azure AD tenant. Allows users from multiple verified domains to authenticate through this connection. Can be an array of domain strings.
[JsonPropertyName("domain_aliases")]
public IEnumerable<string>? DomainAliases { get; set; }
Property Value
ExtGroups
When enabled (true), retrieves and stores Azure AD security group memberships for the user. Requires Microsoft Graph API permissions (Directory.Read.All). Allows configuring max_groups_to_retrieve.
[JsonPropertyName("ext_groups")]
public bool? ExtGroups { get; set; }
Property Value
- bool?
ExtNestedGroups
When true, stores all groups the user is member of, including transitive group memberships (groups within groups). When false (default), only direct group memberships are included.
[JsonPropertyName("ext_nested_groups")]
public bool? ExtNestedGroups { get; set; }
Property Value
- bool?
ExtProfile
When enabled (true), retrieves extended profile attributes from Azure AD via Microsoft Graph API (job title, department, office location, etc.). Requires Graph API permissions. Only available with Azure AD v1 or when explicitly enabled for v2.
[JsonPropertyName("ext_profile")]
public bool? ExtProfile { get; set; }
Property Value
- bool?
FederatedConnectionsAccessTokens
[JsonPropertyName("federated_connections_access_tokens")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsFederatedConnectionsAccessTokens? FederatedConnectionsAccessTokens { get; set; }
Property Value
Granted
Indicates whether admin consent has been granted for the required Azure AD permissions. Read-only status field managed by Auth0 during the OAuth authorization flow.
[JsonPropertyName("granted")]
public bool? Granted { get; set; }
Property Value
- bool?
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
IdentityApi
[JsonPropertyName("identity_api")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsIdentityApiEnum? IdentityApi { get; set; }
Property Value
MaxGroupsToRetrieve
Maximum number of Azure AD groups to retrieve per user during authentication. Helps prevent performance issues for users in many groups. Only applies when ext_groups is enabled. Leave empty to use platform default.
[JsonPropertyName("max_groups_to_retrieve")]
public string? MaxGroupsToRetrieve { get; set; }
Property Value
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
Scope
OAuth 2.0 scopes to request from Azure AD during authentication. Each scope represents a permission (e.g., 'User.Read', 'Group.Read.All'). Only applies with Microsoft Identity Platform v2.0. See Microsoft Graph permissions reference for available scopes.
[JsonPropertyName("scope")]
public IEnumerable<string>? Scope { get; set; }
Property Value
SetUserRootAttributes
[JsonPropertyName("set_user_root_attributes")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsSetUserRootAttributesEnum? SetUserRootAttributes { get; set; }
Property Value
ShouldTrustEmailVerifiedConnection
[JsonPropertyName("should_trust_email_verified_connection")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsShouldTrustEmailVerifiedConnectionEnum? ShouldTrustEmailVerifiedConnection { get; set; }
Property Value
TenantDomain
[JsonPropertyName("tenant_domain")]
public string? TenantDomain { get; set; }
Property Value
TenantId
The Azure AD tenant ID as a UUID. The unique identifier for your Azure AD organization. Must be a valid 36-character UUID.
[JsonPropertyName("tenantId")]
public string? TenantId { get; set; }
Property Value
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
UpstreamParams
[JsonPropertyName("upstream_params")]
public Dictionary<string, object?>? UpstreamParams { get; set; }
Property Value
UseCommonEndpoint
When enabled (true), uses the Azure AD common endpoint for multi-tenant authentication. Allows users from any Azure AD organization to sign in. Requires userid_attribute set to 'sub' (not 'oid'). Cannot be used with SCIM provisioning. Defaults to false.
[JsonPropertyName("useCommonEndpoint")]
public bool? UseCommonEndpoint { get; set; }
Property Value
- bool?
UseWsfed
Indicates WS-Federation protocol usage. When true, uses WS-Federation; when false, uses OpenID Connect.
[JsonPropertyName("use_wsfed")]
public bool? UseWsfed { get; set; }
Property Value
- bool?
UseridAttribute
[JsonPropertyName("userid_attribute")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsUseridAttributeEnum? UseridAttribute { get; set; }
Property Value
WaadProtocol
[JsonPropertyName("waad_protocol")]
public EventStreamCloudEventConnectionUpdatedObject7OptionsWaadProtocolEnum? WaadProtocol { get; set; }
Property Value
Methods
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.