microsoft.graph.internalDomainFederation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ad/json-schema/azure-ad-microsoft-graph-internal-domain-federation-schema.json",
  "title": "microsoft.graph.internalDomainFederation",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-ad-domains-internaldomainfederation-api-openapi.yml#/components/schemas/microsoft.graph.internalDomainFederation",
  "allOf": [
    {
      "$ref": "#/$defs/microsoft.graph.samlOrWsFedProvider"
    },
    {
      "title": "internalDomainFederation",
      "type": "object",
      "properties": {
        "activeSignInUri": {
          "type": [
            "string",
            "null"
          ],
          "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."
        },
        "federatedIdpMfaBehavior": {
          "$ref": "#/$defs/microsoft.graph.federatedIdpMfaBehavior"
        },
        "isSignedAuthenticationRequestRequired": {
          "type": [
            "boolean",
            "null"
          ],
          "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."
        },
        "nextSigningCertificate": {
          "type": [
            "string",
            "null"
          ],
          "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."
        },
        "passwordResetUri": {
          "type": [
            "string",
            "null"
          ]
        },
        "promptLoginBehavior": {
          "$ref": "#/$defs/microsoft.graph.promptLoginBehavior"
        },
        "signingCertificateUpdateStatus": {
          "$ref": "#/$defs/microsoft.graph.signingCertificateUpdateStatus"
        },
        "signOutUri": {
          "type": [
            "string",
            "null"
          ],
          "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."
        }
      },
      "additionalProperties": {
        "type": "object"
      }
    }
  ],
  "$defs": {
    "microsoft.graph.authenticationProtocol": {
      "title": "authenticationProtocol",
      "enum": [
        "wsFed",
        "saml",
        "unknownFutureValue"
      ],
      "type": "string"
    },
    "microsoft.graph.entity": {
      "title": "entity",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for an entity. Read-only."
        }
      },
      "additionalProperties": {
        "type": "object"
      }
    },
    "microsoft.graph.federatedIdpMfaBehavior": {
      "title": "federatedIdpMfaBehavior",
      "enum": [
        "acceptIfMfaDoneByFederatedIdp",
        "enforceMfaByFederatedIdp",
        "rejectMfaByFederatedIdp",
        "unknownFutureValue"
      ],
      "type": "string"
    },
    "microsoft.graph.identityProviderBase": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.entity"
        },
        {
          "title": "identityProviderBase",
          "type": "object",
          "properties": {
            "displayName": {
              "type": [
                "string",
                "null"
              ],
              "description": "The display name of the identity provider."
            }
          },
          "additionalProperties": {
            "type": "object"
          }
        }
      ]
    },
    "microsoft.graph.promptLoginBehavior": {
      "title": "promptLoginBehavior",
      "enum": [
        "translateToFreshPasswordAuthentication",
        "nativeSupport",
        "disabled",
        "unknownFutureValue"
      ],
      "type": "string"
    },
    "microsoft.graph.samlOrWsFedProvider": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.identityProviderBase"
        },
        {
          "title": "samlOrWsFedProvider",
          "type": "object",
          "properties": {
            "issuerUri": {
              "type": [
                "string",
                "null"
              ],
              "description": "Issuer URI of the federation server."
            },
            "metadataExchangeUri": {
              "type": [
                "string",
                "null"
              ],
              "description": "URI of the metadata exchange endpoint used for authentication from rich client applications."
            },
            "passiveSignInUri": {
              "type": [
                "string",
                "null"
              ],
              "description": "URI that web-based clients are directed to when signing in to Microsoft Entra services."
            },
            "preferredAuthenticationProtocol": {
              "$ref": "#/$defs/microsoft.graph.authenticationProtocol"
            },
            "signingCertificate": {
              "type": [
                "string",
                "null"
              ],
              "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."
            }
          },
          "additionalProperties": {
            "type": "object"
          }
        }
      ]
    },
    "microsoft.graph.signingCertificateUpdateStatus": {
      "title": "signingCertificateUpdateStatus",
      "type": "object",
      "properties": {
        "certificateUpdateResult": {
          "type": [
            "string",
            "null"
          ],
          "description": "Status of the last certificate update. Read-only. For a list of statuses, see certificateUpdateResult status."
        },
        "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",
            "null"
          ],
          "description": "Date and time in ISO 8601 format and in UTC time when the certificate was last updated. Read-only.",
          "format": "date-time"
        }
      },
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}