次の方法で共有


internalDomainFederation を更新する

名前空間: microsoft.graph

internalDomainFederation オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Domain.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Domain.ReadWrite.All 注意事項なし。

重要

authenticationType プロパティを更新するには、呼び出し元のアプリに Domain-InternalFederation.ReadWrite.All アクセス許可が割り当てられている必要があります。

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • ドメイン名管理者
  • 外部 ID プロバイダー管理者
  • ハイブリッド ID 管理者
  • セキュリティ管理者

HTTP 要求

PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

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

    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 は、廃止された MSOnline PowerShell モジュールのSet-MsolDomainFederationSettings コマンドレットの SupportsMfa プロパティの進化したバージョンです。

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

    応答

    成功した場合、このメソッドは 204 No Content 応答コードを返します。

    要求

    PATCH https://graph.microsoft.com/v1.0/domains/contoso.com/federationConfiguration/6601d14b-d113-8f64-fda2-9b5ddda18ecc
    Content-Type: application/json
    
    {
      "displayName": "Contoso name change",  
      "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"
    }
    

    応答

    注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

    HTTP/1.1 204 No Content