更新 identityApiConnector

命名空间:microsoft.graph

更新 identityApiConnector 对象 的属性。

Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

权限类型 权限(从最低特权到最高特权)
委派(工作或学校帐户) APIConnectors.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。
应用程序 APIConnectors.ReadWrite.All

工作或学校帐户需要属于以下角色之一:

  • 全局管理员
  • 外部标识用户Flow管理员

HTTP 请求

PATCH /identity/apiConnectors/{identityApiConnectorId}

请求标头

名称 说明
Authorization Bearer {token}。必需。
Content-Type application/json. Required.

请求正文

在请求正文中,提供 identityApiConnector 对象的 JSON 表示形式。

下表显示了 可更新的 identityApiConnector 的属性。

属性 类型 说明
displayName String API 连接器的名称。
targetUrl String 要调用的 API 终结点的 URL。
authenticationConfiguration apiAuthenticationConfigurationBase 描述用于调用 API 的身份验证配置详细信息的对象。 仅 支持基本 身份验证 和 PKCS 12 客户端 证书。

响应

如果成功,此方法返回 204 No Content 响应代码。

示例

示例 1:更改用于显示名称身份验证的 &、targetUrl 和 username 密码

请求

下面展示了示例请求。

PATCH https://graph.microsoft.com/v1.0/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 设置。 若要从基本身份验证更改为证书身份验证,请使用此模式。 若要向证书列表中添加其他证书,请使用 Upload客户端证书方法。 使用此方法时,API 连接器的"Get"或"List"操作的类型将为 authenticationConfiguration microsoft.graph.clientCertificateAuthentication

请求

下面展示了示例请求。

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/be1f769b-9b13-437e-b540-79a905c4932c
Content-Type: application/json

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

响应

下面展示了示例响应。

HTTP/1.1 204 No Content