internalDomainFederation resource type
APIs under the
/beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents configurations of the domains in a tenant that are federated and verified with Microsoft Entra ID. Use this resource to configure federation settings when setting up federation with Microsoft Entra ID. For information on federation, see What is federation with Microsoft Entra ID?.
Inherits from samlOrWsFedProvider.
|Read the properties of the internalDomainFederation object for the domain.
|Create a new internalDomainFederation object.
|Read the properties and relationships of an internalDomainFederation object.
|Update the properties of an internalDomainFederation object.
|Delete an internalDomainFederation object.
|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-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.
|The display name of the federated identity Provider (IdP). Inherited from identityProviderBase.
|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:
unknownFutureValue. For more information, see federatedIdpMfaBehavior values.
|The identifier of the federated identity provider. Inherited from entity.
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.
|Issuer URI of the federation server. Inherited from samlOrWsFedProvider.
|URI of the metadata exchange endpoint used for authentication from rich client applications. Inherited from samlOrWsFedProvider.
|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.
|URI that web-based clients are directed to when signing into Microsoft Entra services. Inherited from samlOrWsFedProvider.
|Preferred authentication protocol. The possible values are:
unknownFutureValue. Inherited from samlOrWsFedProvider.
|Sets the preferred behavior for the sign-in prompt. The possible values are:
|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:
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. Inherited from samlOrWsFedProvider.
|Provides status and timestamp of the last update of the signing certificate.
|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the LogOffUri property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.
|Microsoft Entra ID accepts MFA that's performed by the federated identity provider. If the federated identity provider didn't perform MFA, Microsoft Entra ID performs the MFA.
|Microsoft Entra ID accepts MFA that's performed by federated identity provider. If the federated identity provider didn't perform MFA, it redirects the request to federated identity provider to perform MFA.
|Microsoft Entra ID always performs MFA and rejects MFA that's performed by the federated identity provider.
Note: federatedIdpMfaBehavior is an evolved version of the SupportsMfa property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.
- Switching between federatedIdpMfaBehavior and SupportsMfa isn't supported.
- Once federatedIdpMfaBehavior property is set, Microsoft Entra ID ignores the SupportsMfa setting.
- If the federatedIdpMfaBehavior property is never set, Microsoft Entra ID continues to honor the SupportsMfa setting.
- If neither federatedIdpMfaBehavior nor SupportsMfa is set, Microsoft Entra ID defaults to
Here's a JSON representation of the resource.
"id": "String (identifier)",