Skip to content

agentidentityblueprint-upsert.md

Latest commit

 

History

History
143 lines (112 loc) · 5.29 KB

agentidentityblueprint-upsert.md

File metadata and controls

143 lines (112 loc) · 5.29 KB
title Upsert agentIdentityBlueprint
description Create a new agentIdentityBlueprint object if it doesn't exist, or update the properties of an existing agentIdentityBlueprint object.
author zallison22
ms.date 10/27/2025
ms.localizationpriority medium
ms.subservice entra-agent-id
doc_type apiPageType

Upsert agentIdentityBlueprint

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new agent identity blueprint object if it doesn't exist, or update the properties of an existing object.

Important

Using PATCH to set passwordCredential is not supported. Use the addPassword and removePassword methods to update the password or secret for an agent identity blueprint.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-agentid-apis-write]

HTTP request

To create or update an application, specify the uniqueName client-provided alternate key.

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

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
Prefer create-if-missing. Required for upsert behavior, otherwise the request is treated as an update operation.

Request body

In the request body, supply a JSON representation of the agentIdentityBlueprint object. The request body must contain displayName, which is a required property. Specify other writable properties as necessary for your agentIdentityBlueprint, for creation or update.

Response

If an object with uniqueName doesn't exist, this method returns a 201 Created response code and a new agent identity blueprint object in the response body. The agent identity blueprint is assigned the uniqueName value.

If an object with uniqueName doesn't exist and the Prefer: create-if-missing header is not specified, this method returns a 404 Not Found error code.

If an application object with uniqueName already exists, this method updates the object and returns a 204 No Content response code.

For information about errors returned by agent identity APIs, see Agent identity error codes.

Examples

Request

The following example shows a request.

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

{
  "displayName": "Display name"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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