internalDomainFederation リソースの種類

[アーティクル]
04/09/2024

名前空間: microsoft.graph

Microsoft Entra IDでフェデレーションおよび検証されるテナントドメインの構成を表します。このリソースを使用して、Microsoft Entra IDとのフェデレーションを設定するときにフェデレーション設定を構成します。フェデレーションの詳細については、「Microsoft Entra IDとのフェデレーションとは」を参照してください。

samlOrWsFedProvider から継承します。

メソッド

メソッド	戻り値の種類	説明
internalDomainFederations を一覧表示する	internalDomainFederation コレクション	ドメインの internalDomainFederation オブジェクトのプロパティを読み取ります。
federationConfiguration の作成	internalDomainFederation	新しい internalDomainFederation オブジェクトを作成します。
internalDomainFederation を取得する	internalDomainFederation	internalDomainFederation オブジェクトのプロパティとリレーションシップを読み取ります。
internalDomainFederation を更新する	internalDomainFederation	internalDomainFederation オブジェクトのプロパティを更新します。
internalDomainFederation を削除する	なし	internalDomainFederation オブジェクトを削除します。

プロパティ

プロパティ	型	説明
activeSignInUri	String	Microsoft Entra IDでのシングルサインオン用に設定されたフェデレーションドメインを使用して認証するときに、アクティブなクライアントによって使用されるエンドポイントの URL。 Set-MsolDomainFederationSettings MSOnline v1 PowerShell コマンドレットの ActiveLogOnUri プロパティに対応します。
displayName	String	フェデレーション ID プロバイダー (IdP) の表示名。 identityProviderBase から継承されます。
federatedIdpMfaBehavior	federatedIdpMfaBehavior	フェデレーションユーザーが MFA を必要とする条件付きアクセスポリシーによって管理されるアプリケーションにアクセスするときに、フェデレーション IdP によって実行される MFA をMicrosoft Entra IDが受け入れるかどうかを決定します。使用可能な値: `acceptIfMfaDoneByFederatedIdp`、`enforceMfaByFederatedIdp`、`rejectMfaByFederatedIdp`、`unknownFutureValue`。詳細については、「 federatedIdpMfaBehavior 値」を参照してください。
id	文字列	フェデレーション ID プロバイダーの識別子。エンティティから継承されます。
isSignedAuthenticationRequestRequired	ブール型	の場合`true`、SAML 認証要求がフェデレーション SAML IdP に送信されると、Microsoft Entra IDは OrgID 署名キーを使用してそれらの要求に署名します。 (既定値) の場合 `false` 、フェデレーション IdP に送信された SAML 認証要求は署名されません。
issuerUri	String	フェデレーションサーバーの発行者 URI。 samlOrWsFedProvider から継承されます。
metadataExchangeUri	文字列	リッチクライアントアプリケーションからの認証に使用されるメタデータ交換エンドポイントの URI。 samlOrWsFedProvider から継承されます。
nextSigningCertificate	String	プライマリ署名証明書の有効期限が切れた場合など、トークンの署名にも使用できるフォールバックトークン署名証明書。フェデレーション IdP のトークン署名証明書のパブリック部分の Base64 でエンコードされた文字列として書式設定されます。 X509Certificate2 クラスと互換性がある必要があります。 signingCertificate と同様に、自動ロールオーバー更新プログラムの外部でロールオーバーが必要な場合、新しいフェデレーションサービスが設定されている場合、またはフェデレーションサービス証明書が更新された後に新しいトークン署名証明書がフェデレーションプロパティに存在しない場合は、nextSigningCertificate プロパティが使用されます。
passiveSignInUri	文字列	Microsoft Entra サービスにサインインするときに Web ベースのクライアントが転送する URI。 samlOrWsFedProvider から継承されます。
preferredAuthenticationProtocol	authenticationProtocol	優先認証プロトコル。使用可能な値: `wsFed`、`saml`、`unknownFutureValue`。 samlOrWsFedProvider から継承されます。
promptLoginBehavior	promptLoginBehavior	サインインプロンプトの推奨動作を設定します。使用可能な値: `translateToFreshPasswordAuthentication`、`nativeSupport`、`disabled`、`unknownFutureValue`。
signingCertificate	文字列	Microsoft ID プラットフォームに渡されるトークンの署名に使用される現在の証明書。証明書は、フェデレーション IdP のトークン署名証明書のパブリック部分の Base64 でエンコードされた文字列として書式設定され、X509Certificate2 クラスと互換性がある必要があります。このプロパティは、次のシナリオで使用されます。自動ロールオーバー更新プログラムの外部でロールオーバーが必要な場合新しいフェデレーションサービスが設定されているフェデレーションサービス証明書が更新された後に、新しいトークン署名証明書がフェデレーションプロパティに存在しない場合。 Microsoft Entra IDは、現在の証明書の有効期限が切れる 30 日前に、フェデレーションサービスメタデータから新しい証明書を取得しようとする自動登録プロセスを介して証明書を更新します。新しい証明書が使用できない場合、Microsoft Entra IDはメタデータを毎日監視し、新しい証明書が使用可能になるとドメインのフェデレーション設定を更新します。 samlOrWsFedProvider から継承されます。
signingCertificateUpdateStatus	signingCertificateUpdateStatus	署名証明書の最後の更新の状態とタイムスタンプを提供します。
signOutUri	文字列	クライアントがMicrosoft Entra サービスからサインアウトするときにリダイレクトされる URI。 Set-MsolDomainFederationSettings MSOnline v1 PowerShell コマンドレットのLogOffUri プロパティに対応します。

注:

Azure AD および MSOnline PowerShell モジュールは、2024 年 3 月 30 日の時点で非推奨となりました。詳細については、非推奨の更新プログラムに関するページを参照してください。この日付以降、これらのモジュールのサポートは、Microsoft Graph PowerShell SDK への移行支援とセキュリティ修正に限定されます。非推奨のモジュールは、2025 年 3 月 30 日まで引き続き機能します。

Microsoft Entra ID (旧称 Azure AD) と対話するには、Microsoft Graph PowerShell に移行することをお勧めします。移行に関する一般的な質問については、移行に関する FAQ を参照してください。 メモ： バージョン 1.0.x の MSOnline では、2024 年 6 月 30 日以降に中断が発生する可能性があります。

federatedIdpMfaBehavior 値

メンバー	説明
acceptIfMfaDoneByFederatedIdp	Microsoft Entra IDは、フェデレーション ID プロバイダーによって実行される MFA を受け入れます。フェデレーション ID プロバイダーが MFA を実行しなかった場合、Microsoft Entra IDは MFA を実行します。
enforceMfaByFederatedIdp	Microsoft Entra IDは、フェデレーション ID プロバイダーによって実行される MFA を受け入れます。フェデレーション ID プロバイダーが MFA を実行しなかった場合、MFA を実行するための要求がフェデレーション ID プロバイダーにリダイレクトされます。
rejectMfaByFederatedIdp	Microsoft Entra IDは常に MFA を実行し、フェデレーション ID プロバイダーによって実行される MFA を拒否します。

注:

federatedIdpMfaBehavior は、Set-MsolDomainFederationSettings MSOnline v1 PowerShell コマンドレットの SupportsMfa プロパティの進化したバージョンです。

federatedIdpMfaBehavior と SupportsMfa の切り替えはサポートされていません。
federatedIdpMfaBehavior プロパティが設定されている場合、Microsoft Entra IDは SupportsMfa 設定を無視します。
federatedIdpMfaBehavior プロパティが設定されていない場合、Microsoft Entra IDは引き続き SupportsMfa 設定を受け入れられます。
federatedIdpMfaBehavior も SupportsMfa も設定されていない場合、Microsoft Entra IDは既定で動作しますacceptIfMfaDoneByFederatedIdp。

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.internalDomainFederation",
  "id": "String (identifier)",
  "displayName": "String",
  "issuerUri": "String",
  "metadataExchangeUri": "String",
  "signingCertificate": "String",
  "passiveSignInUri": "String",
  "preferredAuthenticationProtocol": "String",
  "activeSignInUri": "String",
  "signOutUri": "String",
  "promptLoginBehavior": "String",
  "isSignedAuthenticationRequestRequired": "Boolean",
  "nextSigningCertificate": "String",
  "signingCertificateUpdateStatus": {
    "certificateUpdateResult": "String",
    "@odata.type": "microsoft.graph.signingCertificateUpdateStatus"
  },
  "federatedIdpMfaBehavior": "String"
}