Partager via


identityApiConnector : uploadClientCertificate

Espace de noms: microsoft.graph

Chargez une clé de format PKCS 12 (.pfx) dans la configuration d’authentification d’un connecteur d’API. L’entrée est une valeur codée en base 64 du contenu du certificat PKCS 12. Cette méthode retourne un apiConnector.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) APIConnectors.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application APIConnectors.ReadWrite.All Non disponible.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. ID externe’administrateur de flux utilisateur est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /identity/apiconnectors/{id}/uploadClientCertificate

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Propriété Type Description
pkcs12Value String Il s’agit du champ pour l’envoi du contenu pfx. La valeur doit être une version encodée en base 64 du contenu du certificat réel. Obligatoire.
mot de passe Chaîne Il s’agit du mot de passe du fichier pfx. Obligatoire. Si aucun mot de passe n’est utilisé, doit toujours fournir la valeur .""

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et l’apiConnector dont authenticationConfiguration contient les informations publiques du certificat client.

Exemples

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

Note:authenticationConfiguration dans la réponse est de type microsoft.graph.clientCertificateAuthentication , car il représente les informations publiques des certificats chargés.

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