Microsoft Graph · Schema

microsoft.graph.domain

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphdomain-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.domain",
  "title": "microsoft.graph.domain",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "domain",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "authenticationType": {
          "type": "string",
          "description": "Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Microsoft Entra ID performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable.  To update this property in delegated scenarios, the calling app must be assigned the Domain-InternalFederation.ReadWrite.All permission."
        },
        "availabilityStatus": {
          "type": "string",
          "description": "This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.",
          "nullable": true
        },
        "isAdminManaged": {
          "type": "boolean",
          "description": "The value of the property is false if the DNS record management of the domain is delegated to Microsoft 365. Otherwise, the value is true. Not nullable"
        },
        "isDefault": {
          "type": "boolean",
          "description": "true if this is the default domain that is used for user creation. There's only one default domain per company. Not nullable."
        },
        "isInitial": {
          "type": "boolean",
          "description": "true if this is the initial domain created by Microsoft Online Services (contoso.com). There's only one initial domain per company. Not nullable"
        },
        "isRoot": {
          "type": "boolean",
          "description": "true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable."
        },
        "isVerified": {
          "type": "boolean",
          "description": "true if the domain completed domain ownership verification. Not nullable."
        },
        "manufacturer": {
          "type": "string",
          "nullable": true
        },
        "model": {
          "type": "string",
          "nullable": true
        },
        "passwordNotificationWindowInDays": {
          "maximum": 2147483647,
          "minimum": -2147483648,
          "type": "number",
          "description": "Specifies the number of days before a user receives notification that their password expires. If the property isn't set, a default value of 14 days is used.",
          "format": "int32",
          "nullable": true
        },
        "passwordValidityPeriodInDays": {
          "maximum": 2147483647,
          "minimum": -2147483648,
          "type": "number",
          "description": "Specifies the length of time that a password is valid before it must be changed. If the property isn't set, a default value of 90 days is used.",
          "format": "int32",
          "nullable": true
        },
        "state": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.domainState"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Status of asynchronous operations scheduled for the domain."
        },
        "supportedServices": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The capabilities assigned to the domain. Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. The values that you can add or remove using the API include: Email, OfficeCommunicationsOnline, Yammer. Not nullable."
        },
        "domainNameReferences": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.directoryObject"
          },
          "description": "The objects such as users and groups that reference the domain ID. Read-only, Nullable. Doesn't support $expand. Supports $filter by the OData type of objects returned. For example, /domains/{domainId}/domainNameReferences/microsoft.graph.user and /domains/{domainId}/domainNameReferences/microsoft.graph.group.",
          "x-ms-navigationProperty": true
        },
        "federationConfiguration": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.internalDomainFederation"
          },
          "description": "Domain settings configured by a customer when federated with Microsoft Entra ID. Doesn't support $expand.",
          "x-ms-navigationProperty": true
        },
        "rootDomain": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.domain"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Root domain of a subdomain. Read-only, Nullable. Supports $expand.",
          "x-ms-navigationProperty": true
        },
        "serviceConfigurationRecords": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
          },
          "description": "DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support $expand.",
          "x-ms-navigationProperty": true
        },
        "verificationDnsRecords": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
          },
          "description": "DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Doesn't support $expand.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.domain"
}