ConnectionOptionsAzureAD

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionOptionsAzureAD",
  "title": "ConnectionOptionsAzureAD",
  "description": "Options for the 'waad' connection",
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "api_enable_users": {
          "type": "boolean",
          "description": "Enable users API"
        },
        "app_domain": {
          "$ref": "#/components/schemas/ConnectionAppDomainAzureAD"
        },
        "app_id": {
          "type": "string",
          "description": "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.",
          "minLength": 0,
          "maxLength": 500
        },
        "basic_profile": {
          "type": "boolean",
          "description": "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."
        },
        "client_id": {
          "$ref": "#/components/schemas/ConnectionClientIdAzureAD"
        },
        "client_secret": {
          "$ref": "#/components/schemas/ConnectionClientSecretAzureAD"
        },
        "domain_aliases": {
          "$ref": "#/components/schemas/ConnectionDomainAliasesAzureAD"
        },
        "ext_access_token": {
          "type": "boolean",
          "description": "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."
        },
        "ext_account_enabled": {
          "type": "boolean",
          "description": "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."
        },
        "ext_admin": {
          "$ref": "#/components/schemas/ConnectionExtAdmin"
        },
        "ext_agreed_terms": {
          "$ref": "#/components/schemas/ConnectionExtAgreedTerms"
        },
        "ext_assigned_licenses": {
          "type": "boolean",
          "description": "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."
        },
        "ext_assigned_plans": {
          "$ref": "#/components/schemas/ConnectionExtAssignedPlans"
        },
        "ext_azure_id": {
          "type": "boolean",
          "description": "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."
        },
        "ext_city": {
          "type": "boolean",
          "description": "When false, prevents storing the user's city from Azure AD. When true (default), city information is persisted in the user profile."
        },
        "ext_country": {
          "type": "boolean",
          "description": "When false, prevents storing the user's country from Azure AD. When true (default), country information is persisted in the user profile."
        },
        "ext_department": {
          "type": "boolean",
          "description": "When false, prevents storing the user's department from Azure AD. When true (default), department information is persisted in the user profile."
        },
        "ext_dir_sync_enabled": {
          "type": "boolean",
          "description": "When false, prevents storing whether directory synchronization is enabled for the user. When true (default), directory sync status is persisted in the user profile."
        },
        "ext_email": {
          "type": "boolean",
          "description": "When false, prevents storing the user's email address from Azure AD. When true (default), email is persisted in the user profile."
        },
        "ext_expires_in": {
          "type": "boolean",
          "description": "When false, prevents storing the token expiration time (in seconds). When true (default), expiration information is persisted in the user profile."
        },
        "ext_family_name": {
          "type": "boolean",
          "description": "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."
        },
        "ext_fax": {
          "type": "boolean",
          "description": "When false, prevents storing the user's fax number from Azure AD. When true (default), fax information is persisted in the user profile."
        },
        "ext_given_name": {
          "type": "boolean",
          "description": "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."
        },
        "ext_group_ids": {
          "type": "boolean",
          "description": "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."
        },
        "ext_groups": {
          "$ref": "#/components/schemas/ConnectionExtGroupsAzureAD"
        },
        "ext_is_suspended": {
          "$ref": "#/components/schemas/ConnectionExtIsSuspended"
        },
        "ext_job_title": {
          "type": "boolean",
          "description": "When false, prevents storing the user's job title from Azure AD. When true (default), job title information is persisted in the user profile."
        },
        "ext_last_sync": {
          "type": "boolean",
          "description": "When false, prevents storing the timestamp of the last directory synchronization. When true (default), the last sync date is persisted in the user profile."
        },
        "ext_mobile": {
          "type": "boolean",
          "description": "When false, prevents storing the user's mobile phone number from Azure AD. When true (default), mobile number is persisted in the user profile."
        },
        "ext_name": {
          "type": "boolean",
          "description": "When false, prevents storing the user's full name from Azure AD. When true (default), full name is persisted in the user profile."
        },
        "ext_nested_groups": {
          "type": "boolean",
          "description": "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.",
          "default": false
        },
        "ext_nickname": {
          "type": "boolean",
          "description": "When false, prevents storing the user's nickname or display name from Azure AD. When true (default), nickname is persisted in the user profile."
        },
        "ext_oid": {
          "type": "boolean",
          "description": "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."
        },
        "ext_phone": {
          "type": "boolean",
          "description": "When false, prevents storing the user's phone number from Azure AD. When true (default), phone number is persisted in the user profile."
        },
        "ext_physical_delivery_office_name": {
          "type": "boolean",
          "description": "When false, prevents storing the user's office location from Azure AD. When true (default), office location is persisted in the user profile."
        },
        "ext_postal_code": {
          "type": "boolean",
          "description": "When false, prevents storing the user's postal code from Azure AD. When true (default), postal code is persisted in the user profile."
        },
        "ext_preferred_language": {
          "type": "boolean",
          "description": "When false, prevents storing the user's preferred language from Azure AD. When true (default), language preference is persisted in the user profile."
        },
        "ext_profile": {
          "$ref": "#/components/schemas/ConnectionExtProfile"
        },
        "ext_provisioned_plans": {
          "type": "boolean",
          "description": "When false, prevents storing the list of service plans provisioned to the user. When true (default), provisioned plans are persisted in the user profile."
        },
        "ext_provisioning_errors": {
          "type": "boolean",
          "description": "When false, prevents storing provisioning errors that occurred during synchronization. When true (default), error information is persisted. Useful for troubleshooting sync issues."
        },
        "ext_proxy_addresses": {
          "type": "boolean",
          "description": "When false, prevents storing all proxy email addresses (email aliases) for the user. When true (default), proxy addresses are persisted in the user profile."
        },
        "ext_puid": {
          "type": "boolean",
          "description": "When false, prevents storing the user's Passport User ID (puid). When true (default), puid is persisted in the user profile. Legacy attribute."
        },
        "ext_refresh_token": {
          "type": "boolean",
          "description": "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."
        },
        "ext_roles": {
          "type": "boolean",
          "description": "When false, prevents storing Azure AD application roles assigned to the user. When true (default), role information is persisted. Useful for RBAC in applications."
        },
        "ext_state": {
          "type": "boolean",
          "description": "When false, prevents storing the user's state (province/region) from Azure AD. When true (default), state information is persisted in the user profile."
        },
        "ext_street": {
          "type": "boolean",
          "description": "When false, prevents storing the user's street address from Azure AD. When true (default), street address is persisted in the user profile."
        },
        "ext_telephoneNumber": {
          "type": "boolean",
          "description": "When false, prevents storing the user's telephone number from Azure AD. When true (default), telephone number is persisted in the user profile."
        },
        "ext_tenantid": {
          "type": "boolean",
          "description": "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."
        },
        "ext_upn": {
          "type": "boolean",
          "description": "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)."
        },
        "ext_usage_location": {
          "type": "boolean",
          "description": "When false, prevents storing the user's usage location for license assignment. When true (default), usage location is persisted in the user profile."
        },
        "ext_user_id": {
          "type": "boolean",
          "description": "When false, prevents storing an alternative user ID. When true (default), this user ID is persisted in the user profile."
        },
        "federated_connections_access_tokens": {
          "$ref": "#/components/schemas/ConnectionFederatedConnectionsAccessTokens"
        },
        "granted": {
          "type": "boolean",
          "description": "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."
        },
        "icon_url": {
          "$ref": "#/components/schemas/ConnectionIconUrlAzureAD"
        },
        "identity_api": {
          "$ref": "#/components/schemas/ConnectionIdentityApiAzureAD"
        },
        "max_groups_to_retrieve": {
          "$ref": "#/components/schemas/ConnectionMaxGroupsToRetrieve"
        },
        "scope": {
          "$ref": "#/components/schemas/ConnectionScopeAzureAD"
        },
        "set_user_root_attributes": {
          "$ref": "#/components/schemas/ConnectionSetUserRootAttributesEnum"
        },
        "should_trust_email_verified_connection": {
          "$ref": "#/components/schemas/ConnectionShouldTrustEmailVerifiedConnectionEnum"
        },
        "tenant_domain": {
          "$ref": "#/components/schemas/ConnectionTenantDomainAzureAD"
        },
        "tenantId": {
          "$ref": "#/components/schemas/ConnectionTenantIdAzureAD"
        },
        "thumbprints": {
          "$ref": "#/components/schemas/ConnectionThumbprints"
        },
        "upstream_params": {
          "$ref": "#/components/schemas/ConnectionUpstreamParams"
        },
        "use_wsfed": {
          "type": "boolean",
          "description": "Indicates WS-Federation protocol usage. When true, uses WS-Federation; when false, uses OpenID Connect."
        },
        "useCommonEndpoint": {
          "$ref": "#/components/schemas/ConnectionUseCommonEndpointAzureAD"
        },
        "userid_attribute": {
          "$ref": "#/components/schemas/ConnectionUseridAttributeAzureAD"
        },
        "waad_protocol": {
          "$ref": "#/components/schemas/ConnectionWaadProtocol"
        }
      }
    },
    {
      "$ref": "#/components/schemas/ConnectionOptionsCommon"
    }
  ],
  "required": [
    "client_id"
  ],
  "additionalProperties": true
}