application : removeKey

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Supprimez les informations d’identification d’une application. Cette méthode, ainsi que addKey, peut être utilisée par une application pour automatiser le roulement de ses clés arrivant à expiration.

Remarque

Créer le principal de service et mettre à jour les opérations de principal de service peuvent continuer à être utilisées pour ajouter et mettre à jour les informations d’identification de clé pour toute application avec le contexte d’une application ou d’un utilisateur.

Dans le cadre de la validation de demande pour cette méthode, une preuve de possession d’une clé existante est vérifiée avant que l’action puisse être effectuée.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Application.ReadWrite.All Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All

Remarque

Une application n’a pas besoin d’une autorisation spécifique pour déployer ses propres clés.

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Un utilisateur membre non administrateur disposant des autorisations d’utilisateur par défaut pour les applications dont il est propriétaire
  • Développeur d’applications : pour les applications dont il est propriétaire
  • Administrateur de l'application cloud
  • Administrateur de l'application

Requête HTTP

Vous pouvez vous adresser à l’application à l’aide de son ID ou de son AppId. id et appId sont appelés respectivement ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d’administration Microsoft Entra.

POST /applications/{id}/removeKey
POST /applications(appId='{appId}')/removeKey

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, fournissez les propriétés requises suivantes.

Propriété Type Description
keyId Guid Identifiant unique du mot de passe.
preuve String Jeton JWT auto-signé utilisé comme preuve de possession des clés existantes. Ce jeton JWT doit être signé à l’aide de la clé privée de l’un des certificats valides existants de l’application. Le jeton doit contenir les revendications suivantes :
  • aud : L’audience doit être 00000002-0000-0000-c000-000000000000.
  • iss : l’émetteur doit être l’ID de l’application qui initie la demande.
  • nbf : Pas avant l’heure.
  • exp : Le délai d’expiration doit être la valeur de nbf + 10 minutes.

Pour connaître les étapes nécessaires à la génération de ce jeton de preuve de possession, consultez la section Génération de jetons de preuve de possession pour les clés de déploiement.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No content.

Exemples

L’exemple suivant montre comment appeler cette API.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/applications/{id}/removeKey
Content-Type: application/json

{
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "proof":"eyJ0eXAiOiJ..."
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content