x509CertificateAuthenticationMethodConfiguration を更新する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

X.509 証明書の認証方法のプロパティを更新します。

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

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

アクセス許可

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

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

重要

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

HTTP 要求

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate

要求ヘッダー

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

要求本文

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

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

プロパティ 型 説明
authenticationModeConfiguration x509CertificateAuthenticationModeConfiguration 強力な認証構成を定義します。 この構成には、既定の認証モードと、強力な認証バインディングのさまざまな規則が含まれます。
certificateAuthorityScopes x509CertificateAuthorityScope コレクション ユーザーのグループが特定の発行元証明機関からの証明書を使用して正常に認証できるように構成を定義します。
certificateUserBindings x509CertificateUserBinding コレクション 証明書をユーザーにバインドするために、Microsoft Entra ユーザー オブジェクトの属性にマップされる X.509 証明書のフィールドを定義します。 オブジェクトの 優先順位 によって、バインドが実行される順序が決まります。一致する最初のバインドが使用され、残りは無視されます。
crlValidationConfiguration x509CertificateCRLValidationConfiguration 発行元 CA に有効な証明書失効リストが構成されていない場合に証明書ベースの認証が失敗するかどうかを決定します。
issuerHintsConfiguration x509CertificateIssuerHintsConfiguration 証明書ピッカーに表示される証明書をフィルター処理するために、発行者 (CA) のヒントをクライアント側に送り返すかどうかを決定します。
requireCertificateSidAlignment ブール型 true に設定すると、Microsoft Entra IDセキュリティ識別子 (SID) 拡張機能の SID、またはユーザーの X.509 証明書の SAN URI SID 値と、ハイブリッド ユーザーの場合はユーザーのオンプレミス SID 属性、クラウド専用ユーザーの場合はクラウド SID に一致します。 値が一致しない場合、証明書ベースの認証は失敗します。 この値は nullできません。 既定値は false です。 省略可能。
state authenticationMethodState 可能な値は enabled、 disabled です。

メモ:値が #microsoft.graph.x509CertificateAuthenticationMethodConfiguration の @odata.type プロパティを本文に含める必要があります。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。 応答本文では何も返されません。

例

要求

以下に、次のような設定を持つ更新依頼の例を示します。

  • テナントで x509 証明書の認証方法を有効にします。
  • 証明書の PrincipalName と Microsoft Entra ID の onPremisesUserPrincipalName プロパティの間にユーザー バインドを 1 つだけ構成します。
  • 多要素認証を要件として定義します。
  • ルールの種類に対する強力な認証方法のバインド ルールを構成します。
  • ハイブリッド ユーザーとクラウド専用ユーザーには、証明書の SID のアライメントが必要です。
PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration",
    "id": "X509Certificate",
    "state": "enabled",
    "certificateUserBindings": [
        {
            "x509CertificateField": "PrincipalName",
            "userProperty": "onPremisesUserPrincipalName",
            "priority": 1
        }
    ],
    "authenticationModeConfiguration": {
        "x509CertificateAuthenticationDefaultMode": "x509CertificateMultiFactor",
        "rules": [
            {
                "x509CertificateRuleType": "issuerSubject",
                "identifier": "CN=ContosoCA,DC=Contoso,DC=org ",
                "x509CertificateAuthenticationMode": "x509CertificateMultiFactor"
            },
            {
                "x509CertificateRuleType": "policyOID",
                "identifier": "1.2.3.4",
                "x509CertificateAuthenticationMode": "x509CertificateMultiFactor"
            }
        ]
    },
    "issuerHintsConfiguration": {
        "state": "disabled"
    },
    "crlValidationConfiguration": {
        "state": "disabled",
        "exemptedCertificateAuthoritiesSubjectKeyIdentifiers": []
    },
    "certificateAuthorityScopes": [
        {
            "subjectKeyIdentifier": "aaaaaaaabbbbcccc111122222222222222333333",
            "publicKeyInfrastructureIdentifier": "Contoso PKI",
            "includeTargets": [
            {
                "id": "aaaaaaaa-bbbb-cccc-1111-222222222222",
                "targetType": "group"
            }
            ]
        }    
    ],
    "requireCertificateSidAlignment": true,
    "includeTargets": [
        {
            "targetType": "group",
            "id": "all_users",
            "isRegistrationRequired": false
        }
    ]
}

応答

HTTP/1.1 204 No Content