identityApiConnector: uploadClientCertificate

名前空間: microsoft.graph

PKCS 12 形式キー (.pfx) を API コネクタの認証構成にアップロードします。 入力は、PKCS 12 証明書の内容の base-64 でエンコードされた値です。 このメソッドは apiConnector を返します。

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

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

アクセス許可

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

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

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

HTTP 要求

POST /identity/apiconnectors/{id}/uploadClientCertificate

要求ヘッダー

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

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

プロパティ 説明
pkcs12Value String これは、pfx コンテンツを送信するためのフィールドです。 値は、実際の証明書コンテンツの base-64 でエンコードされたバージョンである必要があります。 必須です。
パスワード String これは pfx ファイルのパスワードです。 必須です。 パスワードを使用しない場合は、引き続き "" の値を指定する必要があります。

応答

成功した場合、このメソッドは200 OK応答コードと、authenticationConfigurationにクライアント証明書の公開情報が含まれている apiConnector を返します。

要求

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

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
            }
        ]
    }
}