Upsert agentIdentityBlueprint

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.

Erstellen Sie ein neues Agentidentitäts-Blaupausenobjekt , falls es nicht vorhanden ist, oder aktualisieren Sie die Eigenschaften eines vorhandenen Objekts.

Wichtig

Die Verwendung von PATCH zum Festlegen vob passwordCredential wird nicht unterstützt. Verwenden Sie die addPassword - und removePassword-Methoden , um das Kennwort oder Geheimnis für eine Agent-Identitätsblaupause zu aktualisieren.

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

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

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.ReadWrite.All Nicht verfügbar
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AgentIdentityBlueprint.ReadWrite.All Nicht verfügbar

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

Geben Sie zum Erstellen oder Aktualisieren einer Anwendung den vom Client bereitgestellten alternativen Schlüssel uniqueName an.

PATCH /applications(uniqueName='{uniqueName}')/microsoft.graph.agentIdentityBlueprint

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.
Prefer create-if-missing. Erforderlich für Upsert-Verhalten, andernfalls wird die Anforderung als Update-Vorgang behandelt.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des agentIdentityBlueprint-Objekts an. Der Anforderungstext muss displayName enthalten, eine erforderliche Eigenschaft. Geben Sie andere beschreibbare Eigenschaften an, die für Ihre agentIdentityBlueprint zum Erstellen oder Aktualisieren erforderlich sind.

Antwort

Wenn ein Objekt mit uniqueName nicht vorhanden ist, gibt diese Methode einen 201 Created Antwortcode und ein neues Blueprint-Objekt der Agentidentität im Antworttext zurück. Dem Blueprint der Agent-Identität wird der Wert uniqueName zugewiesen.

Wenn kein Objekt mit uniqueName vorhanden ist und der Prefer: create-if-missing Header nicht angegeben ist, gibt diese Methode einen 404 Not Found Fehlercode zurück.

Wenn bereits ein Anwendungsobjekt mit uniqueName vorhanden ist, aktualisiert diese Methode das Objekt und gibt einen 204 No Content Antwortcode zurück.

Informationen zu Fehlern, die von Agentidentitäts-APIs zurückgegeben werden, finden Sie unter Fehlercodes der Agentidentität.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint
Content-Type: application/json
Prefer: create-if-missing

{
  "displayName": "Display name"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity",
    "id": "03ef14b0-ca33-4840-8f4f-d6e91916010e",
    "deletedDateTime": null,
    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "identifierUris": [],
    "createdDateTime": "2019-09-17T19:10:35.2742618Z",
    "displayName": "Display name",
    "groupMembershipClaims": null,
    "optionalClaims": null,
    "publisherDomain": "contoso.onmicrosoft.com",
    "requiredResourceAccess": [],
    "signInAudience": "AzureADandPersonalMicrosoftAccount",
    "tags": [],
    "tokenEncryptionKeyId": null,
    "api": {
        "requestedAccessTokenVersion": 2,
        "acceptMappedClaims": null,
        "knownClientApplications": [],
        "oauth2PermissionScopes": [],
        "preAuthorizedApplications": []
    },
    "appRoles": [],
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "keyCredentials": [],
    "passwordCredentials": [],
    "uniqueName": "app-65278",
    "web": {
        "redirectUris": [],
        "homePageUrl": null,
        "logoutUrl": null,
        "implicitGrantSettings": {
            "enableIdTokenIssuance": false,
            "enableAccessTokenIssuance": false
        }
    }, 
}