root_domain
Creates, updates, deletes, gets or lists a root_domain resource.
Overview
| Name | root_domain |
| Type | Resource |
| Id | entra_id.domains.root_domain |
Fields
The following fields are returned by SELECT queries:
- get
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
authenticationType | string | 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 | string | 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. |
domainNameReferences | array | 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. |
federationConfiguration | array | Domain settings configured by a customer when federated with Microsoft Entra ID. Doesn't support $expand. |
isAdminManaged | boolean | 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 | boolean | true if this is the default domain that is used for user creation. There's only one default domain per company. Not nullable. |
isInitial | boolean | 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 | boolean | true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable. |
isVerified | boolean | true if the domain completed domain ownership verification. Not nullable. |
manufacturer | string | |
model | string | |
passwordNotificationWindowInDays | number (int32) | 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. |
passwordValidityPeriodInDays | number (int32) | 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. |
rootDomain | | Root domain of a subdomain. Read-only, Nullable. Supports $expand. |
serviceConfigurationRecords | array | 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. |
state | | Status of asynchronous operations scheduled for the domain. |
supportedServices | array | 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. |
verificationDnsRecords | array | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain_id | Get the root domain of a subdomain. This API returns a single object. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
domain_id | string | The unique identifier of domain |
SELECT examples
- get
Get the root domain of a subdomain. This API returns a single object.
SELECT
id,
authenticationType,
availabilityStatus,
domainNameReferences,
federationConfiguration,
isAdminManaged,
isDefault,
isInitial,
isRoot,
isVerified,
manufacturer,
model,
passwordNotificationWindowInDays,
passwordValidityPeriodInDays,
rootDomain,
serviceConfigurationRecords,
state,
supportedServices,
verificationDnsRecords
FROM entra_id.domains.root_domain
WHERE domain_id = '{{ domain_id }}' -- required
;