identityApiConnector を更新する

名前空間: microsoft.graph

重要

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

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

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

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

アクセス許可

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

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

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

HTTP 要求

PATCH /identity/apiConnectors/{identityApiConnectorId}

要求ヘッダー

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

要求本文

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

次の表は、更新可能 な identityApiConnector のプロパティを示しています。

プロパティ 説明
displayName String API コネクタの名前。
targetUrl String 呼び出す API エンドポイントの URL。
authenticationConfiguration apiAuthenticationConfigurationBase API を呼び出すための認証構成の詳細を記述する オブジェクト。 基本認証PKCS 12 クライアント証明書のみがサポートされています。

応答

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

例 1: 基本認証に使用される表示名、targetUrl、およびユーザー名 & パスワードの変更

要求

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

PATCH https://graph.microsoft.com/beta/identity/apiConnectors/{identityApiConnectorId}
Content-Type: application/json

{
  "displayName": "New Test API",
  "targetUrl": "https://otherapi.com/api/endpoint",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.basicAuthentication",
    "username":"<NEW_USERNAME>", 
    "password":"<NEW_PASSWORD>"
  }
}

応答

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

HTTP/1.1 204 No Content

例 2: クライアント証明書認証を使用するように API コネクタを変更する

手記: これにより、以前の authenticationConfiguration 設定が上書きされます。 基本認証から証明書認証に変更するには、これを使用します。 証明書の一覧に証明書を追加するには、 クライアント証明書のアップロード 方法を使用します。 このメソッドを使用する場合、API コネクタの "Get" 操作または "List" 操作は、 authenticationConfigurationmicrosoft.graph.clientCertificateAuthentication 型になります。

要求

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

PATCH https://graph.microsoft.com/beta/identity/apiConnectors/{identityApiConnectorId}
Content-Type: application/json

{
  "authenticationConfiguration": {
    "@odata.type": "#microsoft.graph.pkcs12Certificate",
    "pkcs12Value": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ...kDJ04sJShkkgjL9Bm49plA",
    "password": "secret"
  }
}

応答

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

HTTP/1.1 204 No Content