次の方法で共有


mutualTlsOauthConfiguration を更新する

名前空間: microsoft.graph

重要

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

指定した mutualTlsOauthConfiguration リソースを 更新します。

更新できるのは、 displayNamecertificateAuthority の 2 つのプロパティのみです。

certificateAuthorities コレクション内のオブジェクトのサブセットを更新するには、最初に完全なリストを取得し、変更を加えてから、要求本文の certificateAuthorities 属性リストの内容全体を再投稿します。 オブジェクトのサブセットを除外すると、コレクションから削除されます。

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

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

アクセス許可

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

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

重要

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

  • クラウド デバイス管理者
  • IoT デバイス管理者

HTTP 要求

PATCH /directory/certificateAuthorities/mutualTlsOauthConfigurations/{mutualTlsOauthConfigurationId}

要求ヘッダー

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

要求本文

要求本文で、 mutualTlsOauthConfiguration オブジェクトの JSON 表現を指定します。

mutualTlsOauthConfiguration を更新するときに、次のプロパティを指定できます。

プロパティ 説明
certificateAuthority certificateAuthority コレクション 信頼された証明機関の一覧を表す複数値プロパティ。
displayName String フレンドリ名。

応答

成功した場合、このメソッドは応答コード 200 OK と、応答本文に mutualTlsOauthConfiguration オブジェクトを返します。 証明書の検証手順中に検証エラーが発生した場合、メソッドはエラー メッセージInvalid value specified for property 'certificate' of resource 'CertificateAuthorityInformation'と共に400 Bad Requestを返します。 詳細については、「 Microsoft Graph のエラー応答とリソースの種類」を参照してください。

例 1: 表示名を更新する

次の例では、 mutualTlsOauthConfiguration オブジェクトの表示名を DoorCamera_Model_X_TrustedCAs から THIS_IS_A_NEW_NAME に更新する方法を示します。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/eec5ba11-2fc0-4113-83a2-ed986ed13cdb
Content-Type: application/json

{
  "displayName": "THIS_IS_A_NEW_NAME"
}

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "THIS_IS_A_NEW_NAME",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "@odata.type": "microsoft.graph.certificateAuthority"
    }
  ]
}

例 2: certificateAuthorities の一覧から証明書を削除する

この例では、格納されている元のオブジェクトに次の値があることを前提としています。 開始リソースには、証明機関の一覧に 2 つの値が含まれていることに注意してください。

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id": "eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "joGrWL+Yqkik/CABWG0d1w....",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    },
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "koGrWL+Yqkik/CABWG0d1w....",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}

要求

次の例は、1 つの証明書のみを含む証明機関リストを更新する要求を示しています。この要求では、もう一方の証明書が削除されます。

PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444
Content-Type: application/json

{
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "Binary",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Location: "https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444"

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_subject_dn",
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
      "deltaCertificateRevocationListUrl": null,
      "certificate": "Binary",
      "issuer": "Lakeshore Retail",
      "issuerSubjectkeyIdentifier": "SKI"
    }
  ]
}