openapi: 3.1.0 info: title: Microsoft Graph Domains description: Needs a description. paths: /domains: description: Provides operations to manage the collection of domain entities. get: tags: - Domains.domain summary: Microsoft Graph List domains description: Retrieve a list of domain objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/domain-list?view=graph-rest-1.0 operationId: domains.domain.ListDomain parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/microsoft.graph.domainCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Domains.domain summary: Microsoft Graph Create domain description: >- Adds a domain to the tenant. Important: You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. See List verificationDnsRecords for details. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-post-domains?view=graph-rest-1.0 operationId: domains.domain.CreateDomain requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /domains/{domain-id}: description: Provides operations to manage the collection of domain entities. get: tags: - Domains.domain summary: Microsoft Graph Get domain description: Retrieve the properties and relationships of domain object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/domain-get?view=graph-rest-1.0 operationId: domains.domain.GetDomain parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Domains.domain summary: Microsoft Graph Update domain description: >- Update the properties of domain object. Only verified domains can be updated. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-update?view=graph-rest-1.0 operationId: domains.domain.UpdateDomain requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Domains.domain summary: Microsoft Graph Delete domain description: Delete a domain from a tenant. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-delete?view=graph-rest-1.0 operationId: domains.domain.DeleteDomain parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/domainNameReferences: description: >- Provides operations to manage the domainNameReferences property of the microsoft.graph.domain entity. get: tags: - domains.directoryObject summary: Microsoft Graph List domainNameReferences description: >- Retrieve a list of directoryObject with a reference to the domain. The returned list will contain all directory objects that have a dependency on the domain. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-list-domainnamereferences?view=graph-rest-1.0 operationId: domains.ListDomainNameReferences parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.directoryObjectCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/domainNameReferences/{directoryObject-id}: description: >- Provides operations to manage the domainNameReferences property of the microsoft.graph.domain entity. get: tags: - domains.directoryObject summary: Microsoft Graph Get domainNameReferences from domains 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. operationId: domains.GetDomainNameReferences parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryObject' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /domains/{domain-id}/domainNameReferences/$count: description: Provides operations to count the resources in the collection. get: tags: - domains.directoryObject summary: Microsoft Graph Get the number of the resource operationId: domains.domainNameReferences.GetCount-a205 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/federationConfiguration: description: >- Provides operations to manage the federationConfiguration property of the microsoft.graph.domain entity. get: tags: - domains.internalDomainFederation summary: Microsoft Graph List internalDomainFederations description: >- Read the properties of the internalDomainFederation objects for the domain. This API returns only one object in the collection. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-list-federationconfiguration?view=graph-rest-1.0 operationId: domains.ListFederationConfiguration parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.internalDomainFederationCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - domains.internalDomainFederation summary: Microsoft Graph Create internalDomainFederation description: Create a new internalDomainFederation object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-post-federationconfiguration?view=graph-rest-1.0 operationId: domains.CreateFederationConfiguration requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internalDomainFederation' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internalDomainFederation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/federationConfiguration/{internalDomainFederation-id}: description: >- Provides operations to manage the federationConfiguration property of the microsoft.graph.domain entity. get: tags: - domains.internalDomainFederation summary: Microsoft Graph Get internalDomainFederation description: >- Read the properties and relationships of an internalDomainFederation object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/internaldomainfederation-get?view=graph-rest-1.0 operationId: domains.GetFederationConfiguration parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internalDomainFederation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - domains.internalDomainFederation summary: Microsoft Graph Update internalDomainFederation description: Update the properties of an internalDomainFederation object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/internaldomainfederation-update?view=graph-rest-1.0 operationId: domains.UpdateFederationConfiguration requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internalDomainFederation' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internalDomainFederation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - domains.internalDomainFederation summary: Microsoft Graph Delete internalDomainFederation description: Delete an internalDomainFederation object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/internaldomainfederation-delete?view=graph-rest-1.0 operationId: domains.DeleteFederationConfiguration parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain - name: internalDomainFederation-id in: path description: The unique identifier of internalDomainFederation required: true schema: type: string x-ms-docs-key-type: internalDomainFederation /domains/{domain-id}/federationConfiguration/$count: description: Provides operations to count the resources in the collection. get: tags: - domains.internalDomainFederation summary: Microsoft Graph Get the number of the resource operationId: domains.federationConfiguration.GetCount-9087 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/forceDelete: description: Provides operations to call the forceDelete method. post: tags: - domains.domain.Actions summary: Microsoft Graph Invoke action forceDelete description: >- Delete a domain using an asynchronous long-running operation. Before performing this operation, you must update or remove any references to Exchange as the provisioning service. The following actions are performed as part of this operation: After the domain deletion completes, API operations for the deleted domain return an HTTP 404 status code. To verify deletion of a domain, you can perform a get domain operation. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-forcedelete?view=graph-rest-1.0 operationId: domains.domain.forceDelete requestBody: description: Action parameters content: application/json: schema: type: object properties: disableUserAccounts: type: boolean default: false nullable: true required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/promote: description: Provides operations to call the promote method. post: tags: - domains.domain.Actions summary: Microsoft Graph Invoke action promote description: >- Promote a verified subdomain to the root domain. A verified domain has its isVerified property set to true. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-promote?view=graph-rest-1.0 operationId: domains.domain.promote responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/verify: description: Provides operations to call the verify method. post: tags: - domains.domain.Actions summary: Microsoft Graph Invoke action verify description: >- Validate the ownership of a domain. This operation only applies to an unverified domain. For an unverified domain, the isVerified property is false. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-verify?view=graph-rest-1.0 operationId: domains.domain.verify responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.domain' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/rootDomain: description: >- Provides operations to manage the rootDomain property of the microsoft.graph.domain entity. get: tags: - Domains.domain summary: Microsoft Graph Get rootDomain description: Get the root domain of a subdomain. This API returns a single object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-get-rootdomain?view=graph-rest-1.0 operationId: domains.GetRootDomain parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domain' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/serviceConfigurationRecords: description: >- Provides operations to manage the serviceConfigurationRecords property of the microsoft.graph.domain entity. get: tags: - domains.domainDnsRecord summary: Microsoft Graph List serviceConfigurationRecords description: >- Retrieves a list of domainDnsRecord objects needed to enable services for the domain. Use the returned list to add records to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-list-serviceconfigurationrecords?view=graph-rest-1.0 operationId: domains.ListServiceConfigurationRecords parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.domainDnsRecordCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - domains.domainDnsRecord summary: >- Microsoft Graph Create new navigation property to serviceConfigurationRecords for domains operationId: domains.CreateServiceConfigurationRecords requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}: description: >- Provides operations to manage the serviceConfigurationRecords property of the microsoft.graph.domain entity. get: tags: - domains.domainDnsRecord summary: Microsoft Graph Get serviceConfigurationRecords from domains 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. operationId: domains.GetServiceConfigurationRecords parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - domains.domainDnsRecord summary: Microsoft Graph Update the navigation property serviceConfigurationRecords in domains operationId: domains.UpdateServiceConfigurationRecords requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - domains.domainDnsRecord summary: Microsoft Graph Delete navigation property serviceConfigurationRecords for domains operationId: domains.DeleteServiceConfigurationRecords parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain - name: domainDnsRecord-id in: path description: The unique identifier of domainDnsRecord required: true schema: type: string x-ms-docs-key-type: domainDnsRecord /domains/{domain-id}/serviceConfigurationRecords/$count: description: Provides operations to count the resources in the collection. get: tags: - domains.domainDnsRecord summary: Microsoft Graph Get the number of the resource operationId: domains.serviceConfigurationRecords.GetCount-999b parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/verificationDnsRecords: description: >- Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity. get: tags: - domains.domainDnsRecord summary: Microsoft Graph List verificationDnsRecords description: >- Retrieve a list of domainDnsRecord objects. You cannot use an associated domain with your Microsoft Entra tenant until ownership is verified. To verify the ownership of the domain, retrieve the domain verification records and add the details to the zone file of the domain. This can be done through the domain registrar or DNS server configuration. Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/domain-list-verificationdnsrecords?view=graph-rest-1.0 operationId: domains.ListVerificationDnsRecords parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.domainDnsRecordCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - domains.domainDnsRecord summary: Microsoft Graph Create new navigation property to verificationDnsRecords for domains operationId: domains.CreateVerificationDnsRecords requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}: description: >- Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity. get: tags: - domains.domainDnsRecord summary: Microsoft Graph Get verificationDnsRecords from domains 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. operationId: domains.GetVerificationDnsRecords parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - domains.domainDnsRecord summary: Microsoft Graph Update the navigation property verificationDnsRecords in domains operationId: domains.UpdateVerificationDnsRecords requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainDnsRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - domains.domainDnsRecord summary: Microsoft Graph Delete navigation property verificationDnsRecords for domains operationId: domains.DeleteVerificationDnsRecords parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain - name: domainDnsRecord-id in: path description: The unique identifier of domainDnsRecord required: true schema: type: string x-ms-docs-key-type: domainDnsRecord /domains/{domain-id}/verificationDnsRecords/$count: description: Provides operations to count the resources in the collection. get: tags: - domains.domainDnsRecord summary: Microsoft Graph Get the number of the resource operationId: domains.verificationDnsRecords.GetCount-d5a7 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: domain-id in: path description: The unique identifier of domain required: true schema: type: string x-ms-docs-key-type: domain /domains/$count: description: Provides operations to count the resources in the collection. get: tags: - Domains.domain summary: Microsoft Graph Get the number of the resource operationId: domains.GetCount-3c31 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' components: schemas: 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' microsoft.graph.directoryObject: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: directoryObject required: - '@odata.type' type: object properties: deletedDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- Date and time when this object was deleted. Always null when the object hasn't been deleted. format: date-time nullable: true '@odata.type': type: string discriminator: propertyName: '@odata.type' mapping: '#microsoft.graph.administrativeUnit': '#/components/schemas/microsoft.graph.administrativeUnit' '#microsoft.graph.application': '#/components/schemas/microsoft.graph.application' '#microsoft.graph.appRoleAssignment': '#/components/schemas/microsoft.graph.appRoleAssignment' '#microsoft.graph.certificateAuthorityDetail': '#/components/schemas/microsoft.graph.certificateAuthorityDetail' '#microsoft.graph.certificateBasedAuthPki': '#/components/schemas/microsoft.graph.certificateBasedAuthPki' '#microsoft.graph.contract': '#/components/schemas/microsoft.graph.contract' '#microsoft.graph.device': '#/components/schemas/microsoft.graph.device' '#microsoft.graph.directoryObjectPartnerReference': >- #/components/schemas/microsoft.graph.directoryObjectPartnerReference '#microsoft.graph.directoryRole': '#/components/schemas/microsoft.graph.directoryRole' '#microsoft.graph.directoryRoleTemplate': '#/components/schemas/microsoft.graph.directoryRoleTemplate' '#microsoft.graph.endpoint': '#/components/schemas/microsoft.graph.endpoint' '#microsoft.graph.extensionProperty': '#/components/schemas/microsoft.graph.extensionProperty' '#microsoft.graph.group': '#/components/schemas/microsoft.graph.group' '#microsoft.graph.groupSettingTemplate': '#/components/schemas/microsoft.graph.groupSettingTemplate' '#microsoft.graph.multiTenantOrganizationMember': >- #/components/schemas/microsoft.graph.multiTenantOrganizationMember '#microsoft.graph.organization': '#/components/schemas/microsoft.graph.organization' '#microsoft.graph.orgContact': '#/components/schemas/microsoft.graph.orgContact' '#microsoft.graph.policyBase': '#/components/schemas/microsoft.graph.policyBase' '#microsoft.graph.appManagementPolicy': '#/components/schemas/microsoft.graph.appManagementPolicy' '#microsoft.graph.authorizationPolicy': '#/components/schemas/microsoft.graph.authorizationPolicy' '#microsoft.graph.crossTenantAccessPolicy': '#/components/schemas/microsoft.graph.crossTenantAccessPolicy' '#microsoft.graph.identitySecurityDefaultsEnforcementPolicy': >- #/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy '#microsoft.graph.permissionGrantPolicy': '#/components/schemas/microsoft.graph.permissionGrantPolicy' '#microsoft.graph.stsPolicy': '#/components/schemas/microsoft.graph.stsPolicy' '#microsoft.graph.activityBasedTimeoutPolicy': '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy' '#microsoft.graph.claimsMappingPolicy': '#/components/schemas/microsoft.graph.claimsMappingPolicy' '#microsoft.graph.homeRealmDiscoveryPolicy': '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy' '#microsoft.graph.tokenIssuancePolicy': '#/components/schemas/microsoft.graph.tokenIssuancePolicy' '#microsoft.graph.tokenLifetimePolicy': '#/components/schemas/microsoft.graph.tokenLifetimePolicy' '#microsoft.graph.tenantAppManagementPolicy': '#/components/schemas/microsoft.graph.tenantAppManagementPolicy' '#microsoft.graph.resourceSpecificPermissionGrant': >- #/components/schemas/microsoft.graph.resourceSpecificPermissionGrant '#microsoft.graph.servicePrincipal': '#/components/schemas/microsoft.graph.servicePrincipal' '#microsoft.graph.user': '#/components/schemas/microsoft.graph.user' microsoft.graph.internalDomainFederation: allOf: - $ref: '#/components/schemas/microsoft.graph.samlOrWsFedProvider' - title: internalDomainFederation required: - '@odata.type' type: object properties: activeSignInUri: type: string description: >- URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the ActiveLogOnUri property of the Set-EntraDomainFederationSettings PowerShell cmdlet. nullable: true federatedIdpMfaBehavior: anyOf: - $ref: '#/components/schemas/microsoft.graph.federatedIdpMfaBehavior' - type: object nullable: true description: >- Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: acceptIfMfaDoneByFederatedIdp, enforceMfaByFederatedIdp, rejectMfaByFederatedIdp, unknownFutureValue. For more information, see federatedIdpMfaBehavior values. isSignedAuthenticationRequestRequired: type: boolean description: >- If true, when SAML authentication requests are sent to the federated SAML IdP, Microsoft Entra ID will sign those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IdP aren't signed. nullable: true nextSigningCertificate: type: string description: >- Fallback token signing certificate that can also be used to sign tokens, for example when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the signingCertificate, the nextSigningCertificate property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated. nullable: true passwordResetUri: type: string nullable: true promptLoginBehavior: anyOf: - $ref: '#/components/schemas/microsoft.graph.promptLoginBehavior' - type: object nullable: true description: >- Sets the preferred behavior for the sign-in prompt. The possible values are: translateToFreshPasswordAuthentication, nativeSupport, disabled, unknownFutureValue. signingCertificateUpdateStatus: anyOf: - $ref: >- #/components/schemas/microsoft.graph.signingCertificateUpdateStatus - type: object nullable: true description: >- Provides status and timestamp of the last update of the signing certificate. signOutUri: type: string description: >- URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the LogOffUri property of the Set-EntraDomainFederationSettings PowerShell cmdlet. nullable: true '@odata.type': type: string default: '#microsoft.graph.internalDomainFederation' x-ms-discriminator-value: '#microsoft.graph.internalDomainFederation' microsoft.graph.domainDnsRecord: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: domainDnsRecord required: - '@odata.type' type: object properties: isOptional: type: boolean description: >- If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain. label: type: string description: >- Value used when configuring the name of the DNS record at the DNS host. recordType: type: string description: >- Indicates what type of DNS record this entity represents. The value can be CName, Mx, Srv, or Txt. nullable: true supportedService: type: string description: >- Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. ttl: maximum: 2147483647 minimum: -2147483648 type: number description: >- Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable. format: int32 '@odata.type': type: string discriminator: propertyName: '@odata.type' mapping: '#microsoft.graph.domainDnsCnameRecord': '#/components/schemas/microsoft.graph.domainDnsCnameRecord' '#microsoft.graph.domainDnsMxRecord': '#/components/schemas/microsoft.graph.domainDnsMxRecord' '#microsoft.graph.domainDnsSrvRecord': '#/components/schemas/microsoft.graph.domainDnsSrvRecord' '#microsoft.graph.domainDnsTxtRecord': '#/components/schemas/microsoft.graph.domainDnsTxtRecord' '#microsoft.graph.domainDnsUnavailableRecord': '#/components/schemas/microsoft.graph.domainDnsUnavailableRecord' parameters: top: name: $top in: query description: Show only the first n items style: form explode: false schema: minimum: 0 type: integer example: 50 skip: name: $skip in: query description: Skip the first n items style: form explode: false schema: minimum: 0 type: integer search: name: $search in: query description: Search items by search phrases style: form explode: false schema: type: string filter: name: $filter in: query description: Filter items by property values style: form explode: false schema: type: string count: name: $count in: query description: Include count of items style: form explode: false schema: type: boolean examples: {} responses: microsoft.graph.domainCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.domainCollectionResponse' error: description: error content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' tags: - name: domains.directoryObject - name: Domains.domain - name: domains.domain.Actions - name: domains.domainDnsRecord - name: domains.internalDomainFederation