Table of Contents

Class ConnectionOptionsAzureAd

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll

Options for the 'waad' connection

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

Properties

AdditionalProperties 

[JsonIgnore]
public AdditionalProperties AdditionalProperties { get; set; }

Property Value

AdditionalProperties

ApiEnableUsers

Enable users API

[JsonPropertyName("api_enable_users")]
public bool? ApiEnableUsers { get; set; }

Property Value

bool?

AppDomain 

[JsonPropertyName("app_domain")]
public string? AppDomain { get; set; }

Property Value

string

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

string

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?

ClientId 

[JsonPropertyName("client_id")]
public required string ClientId { get; set; }

Property Value

string

ClientSecret 

[JsonPropertyName("client_secret")]
public string? ClientSecret { get; set; }

Property Value

string

DomainAliases 

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

Property Value

IEnumerable<string>

ExtAccessToken

When false, prevents storing the user's Azure AD access token in the Auth0 user profile. When true (default), the access token is persisted for API access.

[JsonPropertyName("ext_access_token")]
public bool? ExtAccessToken { get; set; }

Property Value

bool?

ExtAccountEnabled

When false, prevents storing whether the user's Azure AD account is enabled. When true (default), the account enabled status is persisted in the user profile.

[JsonPropertyName("ext_account_enabled")]
public bool? ExtAccountEnabled { get; set; }

Property Value

bool?

ExtAdmin 

[JsonPropertyName("ext_admin")]
public bool? ExtAdmin { get; set; }

Property Value

bool?

ExtAgreedTerms 

[JsonPropertyName("ext_agreed_terms")]
public bool? ExtAgreedTerms { get; set; }

Property Value

bool?

ExtAssignedLicenses

When false, prevents storing the list of Microsoft 365/Office 365 licenses assigned to the user. When true (default), license information is persisted in the user profile.

[JsonPropertyName("ext_assigned_licenses")]
public bool? ExtAssignedLicenses { get; set; }

Property Value

bool?

ExtAssignedPlans 

[JsonPropertyName("ext_assigned_plans")]
public bool? ExtAssignedPlans { get; set; }

Property Value

bool?

ExtAzureId

When false, prevents storing the user's Azure ID identifier. When true (default), the Azure ID is persisted. Note: 'oid' (Object ID) is the recommended unique identifier for single-tenant connections.

[JsonPropertyName("ext_azure_id")]
public bool? ExtAzureId { get; set; }

Property Value

bool?

ExtCity

When false, prevents storing the user's city from Azure AD. When true (default), city information is persisted in the user profile.

[JsonPropertyName("ext_city")]
public bool? ExtCity { get; set; }

Property Value

bool?

ExtCountry

When false, prevents storing the user's country from Azure AD. When true (default), country information is persisted in the user profile.

[JsonPropertyName("ext_country")]
public bool? ExtCountry { get; set; }

Property Value

bool?

ExtDepartment

When false, prevents storing the user's department from Azure AD. When true (default), department information is persisted in the user profile.

[JsonPropertyName("ext_department")]
public bool? ExtDepartment { get; set; }

Property Value

bool?

ExtDirSyncEnabled

When false, prevents storing whether directory synchronization is enabled for the user. When true (default), directory sync status is persisted in the user profile.

[JsonPropertyName("ext_dir_sync_enabled")]
public bool? ExtDirSyncEnabled { get; set; }

Property Value

bool?

ExtEmail

When false, prevents storing the user's email address from Azure AD. When true (default), email is persisted in the user profile.

[JsonPropertyName("ext_email")]
public bool? ExtEmail { get; set; }

Property Value

bool?

ExtExpiresIn

When false, prevents storing the token expiration time (in seconds). When true (default), expiration information is persisted in the user profile.

[JsonPropertyName("ext_expires_in")]
public bool? ExtExpiresIn { get; set; }

Property Value

bool?

ExtFamilyName

When false, prevents storing the user's family name (last name) from Azure AD. When true (default), family name is persisted in the user profile.

[JsonPropertyName("ext_family_name")]
public bool? ExtFamilyName { get; set; }

Property Value

bool?

ExtFax

When false, prevents storing the user's fax number from Azure AD. When true (default), fax information is persisted in the user profile.

[JsonPropertyName("ext_fax")]
public bool? ExtFax { get; set; }

Property Value

bool?

ExtGivenName

When false, prevents storing the user's given name (first name) from Azure AD. When true (default), given name is persisted in the user profile.

[JsonPropertyName("ext_given_name")]
public bool? ExtGivenName { get; set; }

Property Value

bool?

ExtGroupIds

When false, prevents storing the list of Azure AD group IDs the user is a member of. When true (default), group membership IDs are persisted. See ext_groups for retrieving group details.

[JsonPropertyName("ext_group_ids")]
public bool? ExtGroupIds { get; set; }

Property Value

bool?

ExtGroups 

[JsonPropertyName("ext_groups")]
public bool? ExtGroups { get; set; }

Property Value

bool?

ExtIsSuspended 

[JsonPropertyName("ext_is_suspended")]
public bool? ExtIsSuspended { get; set; }

Property Value

bool?

ExtJobTitle

When false, prevents storing the user's job title from Azure AD. When true (default), job title information is persisted in the user profile.

[JsonPropertyName("ext_job_title")]
public bool? ExtJobTitle { get; set; }

Property Value

bool?

ExtLastSync

When false, prevents storing the timestamp of the last directory synchronization. When true (default), the last sync date is persisted in the user profile.

[JsonPropertyName("ext_last_sync")]
public bool? ExtLastSync { get; set; }

Property Value

bool?

ExtMobile

When false, prevents storing the user's mobile phone number from Azure AD. When true (default), mobile number is persisted in the user profile.

[JsonPropertyName("ext_mobile")]
public bool? ExtMobile { get; set; }

Property Value

bool?

ExtName

When false, prevents storing the user's full name from Azure AD. When true (default), full name is persisted in the user profile.

[JsonPropertyName("ext_name")]
public bool? ExtName { 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?

ExtNickname

When false, prevents storing the user's nickname or display name from Azure AD. When true (default), nickname is persisted in the user profile.

[JsonPropertyName("ext_nickname")]
public bool? ExtNickname { get; set; }

Property Value

bool?

ExtOid

When false, prevents storing the user's Object ID (oid) from Azure AD. When true (default), the oid is persisted. Note: 'oid' is the recommended unique identifier for single-tenant connections and required for SCIM.

[JsonPropertyName("ext_oid")]
public bool? ExtOid { get; set; }

Property Value

bool?

ExtPhone

When false, prevents storing the user's phone number from Azure AD. When true (default), phone number is persisted in the user profile.

[JsonPropertyName("ext_phone")]
public bool? ExtPhone { get; set; }

Property Value

bool?

ExtPhysicalDeliveryOfficeName

When false, prevents storing the user's office location from Azure AD. When true (default), office location is persisted in the user profile.

[JsonPropertyName("ext_physical_delivery_office_name")]
public bool? ExtPhysicalDeliveryOfficeName { get; set; }

Property Value

bool?

ExtPostalCode

When false, prevents storing the user's postal code from Azure AD. When true (default), postal code is persisted in the user profile.

[JsonPropertyName("ext_postal_code")]
public bool? ExtPostalCode { get; set; }

Property Value

bool?

ExtPreferredLanguage

When false, prevents storing the user's preferred language from Azure AD. When true (default), language preference is persisted in the user profile.

[JsonPropertyName("ext_preferred_language")]
public bool? ExtPreferredLanguage { get; set; }

Property Value

bool?

ExtProfile 

[JsonPropertyName("ext_profile")]
public bool? ExtProfile { get; set; }

Property Value

bool?

ExtProvisionedPlans

When false, prevents storing the list of service plans provisioned to the user. When true (default), provisioned plans are persisted in the user profile.

[JsonPropertyName("ext_provisioned_plans")]
public bool? ExtProvisionedPlans { get; set; }

Property Value

bool?

ExtProvisioningErrors

When false, prevents storing provisioning errors that occurred during synchronization. When true (default), error information is persisted. Useful for troubleshooting sync issues.

[JsonPropertyName("ext_provisioning_errors")]
public bool? ExtProvisioningErrors { get; set; }

Property Value

bool?

ExtProxyAddresses

When false, prevents storing all proxy email addresses (email aliases) for the user. When true (default), proxy addresses are persisted in the user profile.

[JsonPropertyName("ext_proxy_addresses")]
public bool? ExtProxyAddresses { get; set; }

Property Value

bool?

ExtPuid

When false, prevents storing the user's Passport User ID (puid). When true (default), puid is persisted in the user profile. Legacy attribute.

[JsonPropertyName("ext_puid")]
public bool? ExtPuid { get; set; }

Property Value

bool?

ExtRefreshToken

When false, prevents storing the Azure AD refresh token. When true (default), the refresh token is persisted for offline access. Required for token refresh in long-lived applications.

[JsonPropertyName("ext_refresh_token")]
public bool? ExtRefreshToken { get; set; }

Property Value

bool?

ExtRoles

When false, prevents storing Azure AD application roles assigned to the user. When true (default), role information is persisted. Useful for RBAC in applications.

[JsonPropertyName("ext_roles")]
public bool? ExtRoles { get; set; }

Property Value

bool?

ExtState

When false, prevents storing the user's state (province/region) from Azure AD. When true (default), state information is persisted in the user profile.

[JsonPropertyName("ext_state")]
public bool? ExtState { get; set; }

Property Value

bool?

ExtStreet

When false, prevents storing the user's street address from Azure AD. When true (default), street address is persisted in the user profile.

[JsonPropertyName("ext_street")]
public bool? ExtStreet { get; set; }

Property Value

bool?

ExtTelephoneNumber

When false, prevents storing the user's telephone number from Azure AD. When true (default), telephone number is persisted in the user profile.

[JsonPropertyName("ext_telephoneNumber")]
public bool? ExtTelephoneNumber { get; set; }

Property Value

bool?

ExtTenantid

When false, prevents storing the user's Azure AD tenant ID. When true (default), tenant ID is persisted. Useful for identifying which Azure AD organization the user belongs to.

[JsonPropertyName("ext_tenantid")]
public bool? ExtTenantid { get; set; }

Property Value

bool?

ExtUpn

When false, prevents storing the user's User Principal Name (UPN) from Azure AD. When true (default), UPN is persisted. UPN is the user's logon name (e.g., user@contoso.com).

[JsonPropertyName("ext_upn")]
public bool? ExtUpn { get; set; }

Property Value

bool?

ExtUsageLocation

When false, prevents storing the user's usage location for license assignment. When true (default), usage location is persisted in the user profile.

[JsonPropertyName("ext_usage_location")]
public bool? ExtUsageLocation { get; set; }

Property Value

bool?

ExtUserId

When false, prevents storing an alternative user ID. When true (default), this user ID is persisted in the user profile.

[JsonPropertyName("ext_user_id")]
public bool? ExtUserId { get; set; }

Property Value

bool?

FederatedConnectionsAccessTokens 

[JsonPropertyName("federated_connections_access_tokens")]
public Optional<ConnectionFederatedConnectionsAccessTokens?> FederatedConnectionsAccessTokens { get; set; }

Property Value

Optional<ConnectionFederatedConnectionsAccessTokens>

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 

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

Property Value

string

IdentityApi 

[JsonPropertyName("identity_api")]
public ConnectionIdentityApiEnumAzureAd? IdentityApi { get; set; }

Property Value

ConnectionIdentityApiEnumAzureAd?

MaxGroupsToRetrieve 

[JsonPropertyName("max_groups_to_retrieve")]
public string? MaxGroupsToRetrieve { get; set; }

Property Value

string

NonPersistentAttrs 

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

Property Value

IEnumerable<string>

Scope 

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

Property Value

IEnumerable<string>

SetUserRootAttributes 

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

Property Value

ConnectionSetUserRootAttributesEnum?

ShouldTrustEmailVerifiedConnection 

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

Property Value

ConnectionShouldTrustEmailVerifiedConnectionEnum?

TenantDomain 

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

Property Value

string

TenantId 

[JsonPropertyName("tenantId")]
public string? TenantId { get; set; }

Property Value

string

Thumbprints 

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

Property Value

IEnumerable<string>

UpstreamParams 

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

Property Value

Optional<Dictionary<string, ConnectionUpstreamAdditionalProperties>>

UseCommonEndpoint 

[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 ConnectionUseridAttributeEnumAzureAd? UseridAttribute { get; set; }

Property Value

ConnectionUseridAttributeEnumAzureAd?

WaadProtocol 

[JsonPropertyName("waad_protocol")]
public ConnectionWaadProtocolEnumAzureAd? WaadProtocol { get; set; }

Property Value

ConnectionWaadProtocolEnumAzureAd?

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.