Freigeben über


servicePrincipal: removeKey

Namespace: microsoft.graph

Entfernen Sie Schlüsselanmeldeinformationen aus einem servicePrincipal. Diese Methode kann zusammen mit addKey von einem servicePrincipal verwendet werden, um das Rollrollen der ablaufenden Schlüssel zu automatisieren.

Hinweis

Die Vorgänge "servicePrincipal" und "Update servicePrincipal " können weiterhin verwendet werden, um Schlüsselanmeldeinformationen für jeden servicePrincipal mit oder ohne Benutzerkontext hinzuzufügen und zu aktualisieren.

Im Rahmen der Anforderungsüberprüfung für diese Methode wird ein Nachweis des Besitzes eines vorhandenen Schlüssels überprüft, bevor die Aktion ausgeführt werden kann.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Application.ReadWrite.All Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

HTTP-Anforderung

Sie können den Dienstprinzipal entweder mit seiner ID oder appId adressieren. id und appId werden in App-Registrierungen im Microsoft Entra Admin Center als Objekt-ID bzw. Anwendungs-ID (Client-ID) bezeichnet.

POST /serviceprincipals/{id}/removeKey
POST /servicePrincipals(appId='{appId}')/removeKey

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext die folgenden erforderlichen Eigenschaften an.

Eigenschaft Typ Beschreibung
keyId GUID Der eindeutige Bezeichner für das Kennwort.
Beweis String Ein selbstsigniertes JWT-Token, das als Nachweis des Besitzes der vorhandenen Schlüssel verwendet wird. Dieses JWT-Token muss mit einem privaten Schlüssel signiert werden, der einem der vorhandenen gültigen Zertifikate entspricht, die dem servicePrincipal zugeordnet sind. Das Token sollte den folgenden Anforderungen enthalten:
  • aud: Zielgruppe muss sein 00000002-0000-0000-c000-000000000000.
  • iss: Aussteller muss die ID des servicePrincipal sein, der die Anforderung initiiert.
  • nbf: Nicht vor der Zeit.
  • exp: Ablaufzeit sollte der Wert nbf + 10 Minuten sein.

Schritte zum Generieren dieses Besitznachweistokens finden Sie unter Generieren von Besitznachweistoken für rollende Schlüssel.

Antwort

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No content zurückgegeben.

Beispiele

Im folgenden Beispiel wird gezeigt, wie diese API aufgerufen wird.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/removeKey
Content-Type: application/json

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

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content