agentIdentityBlueprint: addKey

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Hinzufügen von Schlüsselanmeldeinformationen zu einer agentIdentityBlueprint. Diese Methode kann zusammen mit removeKey verwendet werden, um das Rollieren der ablaufenden Schlüssel zu automatisieren.

Hinweis

Sie sollten nur den Wert des öffentlichen Schlüssels angeben, wenn Sie Ihrer Anwendung Zertifikatanmeldeinformationen hinzufügen. Wenn Sie Ihrer Anwendung ein Zertifikat mit einem privaten Schlüssel hinzufügen, besteht das Risiko, dass die Anwendung gefährdet wird.

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

Agentidentitäts-Blaupausen, die über keine gültigen Zertifikate verfügen (es wurden noch keine Zertifikate hinzugefügt oder alle Zertifikate sind abgelaufen), können diese Dienstaktion nicht verwenden. Sie können stattdessen den Blaupausenvorgang "Agent-Identität aktualisieren" verwenden, um ein Update durchzuführen.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

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

Wichtig

  • Ein Prinzipal, der eine Agentidentität, eine Blaupause oder einen Blaupausenprinzipal erstellt, wird automatisch als Besitzer zugewiesen.
  • Besitzer können Agentidentitäten erstellen und ändern, die einer Blaupause zugeordnet sind, die sie besitzen, ohne dass ihnen eine Agent-ID-Rolle zugewiesen wird.
  • Damit Nichtbesitzer diese API in delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten aufrufen können, muss dem Administrator eine Rolle für den unterstützten Microsoft Entra zugewiesen werden. Dieser Vorgang unterstützt die folgende integrierte Rolle mit den geringsten Berechtigungen:

HTTP-Anforderung

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey

Anforderungsheader

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

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an. In der folgenden Tabelle sind die Parameter aufgeführt, die erforderlich sind, wenn Sie diese Aktion aufrufen.

Eigenschaft Typ Beschreibung
keyCredential keyCredential Die neuen Anmeldeinformationen für den Anwendungsschlüssel, die hinzugefügt werden sollen. Typ, Verwendung und Schlüssel sind erforderliche Eigenschaften für diese Verwendung. Folgende Schlüsseltypen werden unterstützt:
  • AsymmetricX509Cert: Die Verwendung muss Verifysein.
  • X509CertAndPassword: Die Verwendung muss Sign
passwordCredential passwordCredential Es muss nur secretText eingestellt werden, der das Passwort für den Schlüssel enthalten soll. Diese Eigenschaft ist nur für Schlüssel des Typs X509CertAndPassword. Legen Sie ihn auf einen anderen Wert fest null .
Beweis Zeichenfolge Ein selbstsignierter JWT-Token, der als Nachweis des Besitzes der vorhandenen Schlüssel verwendet wird. Dieses JWT-Token muss mit dem privaten Schlüssel eines der vorhandenen gültigen Zertifikate der Anwendung signiert werden. Das Token sollte den folgenden Anforderungen enthalten:
  • aud: Das Publikum muss sein 00000002-0000-0000-c000-000000000000.
  • iss: Issuer muss die ID der Anwendung sein, die die Anforderung initiiert.
  • nbf: Nicht vor der Zeit.
  • exp: Die Ablaufzeit sollte der Wert NBF + 10 Minuten sein.

Schritte zum Generieren dieses Besitznachweis-Tokens finden Sie unter Generieren von Besitznachweis-Token für Rolling Keys. Weitere Informationen zu den Anspruchstypen finden Sie unter Anspruchsnutzlast.

Antwort

Bei erfolgreicher Ausführung gibt diese Aktion einen 200 OK Antwortcode und einen KeyCredential im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

{
  "keyCredential": {
    "@odata.type": "microsoft.graph.keyCredential"
  },
  "passwordCredential": {
    "@odata.type": "microsoft.graph.passwordCredential"
  },
  "proof": "String"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
  "value": {
    "@odata.type": "microsoft.graph.keyCredential"
  }
}
  • Last updated on