identityApiConnector:uploadClientCertificate

命名空间:microsoft.graph

Upload API 连接器的身份验证配置 (.pfx) PKCS 12 格式密钥。 输入是 PKCS 12 证书内容的 Base64 编码值。 此方法返回 apiConnector

权限

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

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

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

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

HTTP 请求

POST /identity/apiconnectors/{id}/uploadClientCertificate

请求标头

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

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

属性 类型 说明
pkcs12Value String 这是用于发送 pfx 内容的字段。 该值应为实际证书内容的 Base64 编码版本。 必需项。
密码 String 这是 pfx 文件的密码。 必需项。 如果未使用密码,则仍必须提供 的值 ""

响应

如果成功,此方法将返回 响应200 OK代码和 apiConnectorauthenticationConfiguration,其中包含客户端证书的公共信息。

示例

请求

下面展示了示例请求。

POST https://graph.microsoft.com/v1.0/identity/apiconnectors/{id}/uploadClientCertificate
Content-type: application/json

{
    "pkcs12Value": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ...kDJ04sJShkkgjL9Bm49plA",
    "password": "<password>"
}

响应

下面展示了示例响应。

注意: authenticationConfiguration 响应中的 类型为 microsoft.graph.clientCertificateAuthentication ,因为这表示已上载证书的公共信息。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/apiConnectors/$entity",
    "id": "45715bb8-13f9-4bf6-927f-ef96c102d394",
    "displayName": "My API connector",
    "targetUrl": "https://api.contoso.com/endpoint",
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.clientCertificateAuthentication",
        "certificateList": [
            {
                "thumbprint": "0EB255CC895477798BA418B378255204304897AD",
                "notAfter": 1666350522,
                "notBefore": 1508670522,
                "isActive": true
            }
        ]
    }
}