Microsoft Graph Domains.domain API

openapi: 3.2.0
info:
  title: Microsoft Graph Admin Admin.admin Domains.domain API
  description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID.

    This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations,

    site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements,

    SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.'
  version: 1.0.0
  contact:
    name: Microsoft Graph API Support
    url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
  description: Microsoft Graph API v1.0 endpoint
tags:
- name: Domains.domain
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.
    parameters:
    - name: domain-id
      in: path
      description: The unique identifier of domain
      required: true
      schema:
        type: string
      x-ms-docs-key-type: domain
    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
  /domains/{domain-id}/rootDomain:
    description: Provides operations to manage the rootDomain property of the microsoft.graph.domain entity.
    parameters:
    - name: domain-id
      in: path
      description: The unique identifier of domain
      required: true
      schema:
        type: string
      x-ms-docs-key-type: domain
    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
  /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:
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
          nullable: true
    microsoft.graph.domainState:
      title: domainState
      required:
      - '@odata.type'
      type: object
      properties:
        lastActionDateTime:
          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: Timestamp for when the last activity occurred. The value is updated when an operation is scheduled, the asynchronous task starts, and when the operation completes.
          format: date-time
          nullable: true
        operation:
          type: string
          description: Type of asynchronous operation. The values can be ForceDelete or Verification.
          nullable: true
        status:
          type: string
          description: Current status of the operation.  Scheduled - Operation is scheduled but hasn't started.  InProgress - Task is in progress.  Failed - The operation failed.
          nullable: true
        '@odata.type':
          type: string
    microsoft.graph.domainCollectionResponse:
      title: Collection of domain
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
      - type: object
        properties:
          value:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.domain'
    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'
    microsoft.graph.ODataErrors.InnerError:
      title: InnerError
      required:
      - '@odata.type'
      type: object
      properties:
        request-id:
          type: string
          description: Request Id as tracked internally by the service
          nullable: true
        client-request-id:
          type: string
          description: Client request Id as sent by the client application.
          nullable: true
        date:
          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 when the error occured.
          format: date-time
          nullable: true
        '@odata.type':
          type: string
    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.signingCertificateUpdateStatus:
      title: signingCertificateUpdateStatus
      required:
      - '@odata.type'
      type: object
      properties:
        certificateUpdateResult:
          type: string
          description: Status of the last certificate update. Read-only. For a list of statuses, see certificateUpdateResult status.
          nullable: true
        lastRunDateTime:
          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 in ISO 8601 format and in UTC time when the certificate was last updated. Read-only.
          format: date-time
          nullable: true
        '@odata.type':
          type: string
    microsoft.graph.samlOrWsFedProvider:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.identityProviderBase'
      - title: samlOrWsFedProvider
        required:
        - '@odata.type'
        type: object
        properties:
          issuerUri:
            type: string
            description: Issuer URI of the federation server.
            nullable: true
          metadataExchangeUri:
            type: string
            description: URI of the metadata exchange endpoint used for authentication from rich client applications.
            nullable: true
          passiveSignInUri:
            type: string
            description: URI that web-based clients are directed to when signing in to Microsoft Entra services.
            nullable: true
          preferredAuthenticationProtocol:
            anyOf:
            - $ref: '#/components/schemas/microsoft.graph.authenticationProtocol'
            - type: object
              nullable: true
            description: 'Preferred authentication protocol. The possible values are: wsFed, saml, unknownFutureValue.'
          signingCertificate:
            type: string
            description: 'Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP''s token signing certificate and must be compatible with the X509Certificate2 class.   This property is used in the following scenarios:  if a rollover is required outside of the autorollover update a new federation service is being set up  if the new token signing certificate isn''t present in the federation properties after the federation service certificate has been updated.   Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn''t available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.'
            nullable: true
          '@odata.type':
            type: string
            default: '#microsoft.graph.samlOrWsFedProvider'
        discriminator:
          propertyName: '@odata.type'
          mapping:
            '#microsoft.graph.internalDomainFederation': '#/components/schemas/microsoft.graph.internalDomainFederation'
            '#microsoft.graph.samlOrWsFedExternalDomainFederation': '#/components/schemas/microsoft.graph.samlOrWsFedExternalDomainFederation'
    microsoft.graph.federatedIdpMfaBehavior:
      title: federatedIdpMfaBehavior
      enum:
      - acceptIfMfaDoneByFederatedIdp
      - enforceMfaByFederatedIdp
      - rejectMfaByFederatedIdp
      - unknownFutureValue
      type: string
    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.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type: string
          nullable: true
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
    microsoft.graph.authenticationProtocol:
      title: authenticationProtocol
      enum:
      - wsFed
      - saml
      - unknownFutureValue
      type: string
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
    BaseCollectionPaginationCountResponse:
      title: Base collection pagination and count responses
      type: object
      properties:
        '@odata.count':
          type: integer
          format: int64
          nullable: true
        '@odata.nextLink':
          type: string
          nullable: true
    microsoft.graph.promptLoginBehavior:
      title: promptLoginBehavior
      enum:
      - translateToFreshPasswordAuthentication
      - nativeSupport
      - disabled
      - unknownFutureValue
      type: string
    microsoft.graph.identityProviderBase:
      allOf:
      - $r

# --- truncated at 32 KB (155 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/microsoft-graph-domains-domain-api-openapi.yml