Edit

Create agentIdentity

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new agentIdentity object from the specified agent identity blueprint.

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) AgentIdentity.Create.All AgentIdentity.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application AgentIdentity.Create.All AgentIdentity.CreateAsManager, AgentIdentity.ReadWrite.All

Important

  • A principal who creates an agent identity blueprint or blueprint principal is automatically assigned as the owner.
  • Owners can create and modify agent identities associated with a blueprint they own without being assigned an Agent ID role.
  • For nonowners to call this API in delegated scenarios using work or school accounts, the admin must be assigned a supported Microsoft Entra role. This operation supports the following least-privileged built-in role:

HTTP request

POST /servicePrincipals/microsoft.graph.agentIdentity

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of a agentIdentity object. The request body must contain displayName, agentIdentityBlueprintId, and a valid sponsor reference.

The displayName must follow the agent identity display-name character rules.

For a blueprint with isSingleInstance set to true, this operation creates an agent identity backed directly by that blueprint without creating an agent identity blueprint principal. Its instanceMode is singleInstance. For the default multi-instance topology, instanceMode is multiInstance. The service determines instanceMode; don't supply it in the request body.

Response

If successful, this method returns a 201 Created response code and a agentIdentity object in the response body.

If displayName contains prohibited characters, this method returns 400 Bad Request with a property-specific ProhibitedCharactersInDisplayName error code for displayName. The error message identifies the prohibited Unicode code points.

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

If an active single-instance agent identity already exists for the same blueprint in the tenant, this method returns 409 Conflict.

Examples

Example 1: Create a multi-instance agent identity

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/servicePrincipals/microsoft.graph.agentIdentity
Content-type: application/json

{
  "displayName": "My Agent Identity",
  "agentIdentityBlueprintId": "65415bb1-9267-4313-bbf5-ae259732ee12",
  "sponsors@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/acc9f0a1-9075-464f-9fe7-049bf1ae6481",
    "https://graph.microsoft.com/v1.0/groups/47309f33-e0ff-7be6-defe-28b504c8cd2e"
  ]
}

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#servicePrincipals/$entity",
    "@odata.type": "#microsoft.graph.agentIdentity",
    "id": "59e617e5-e447-4adc-8b88-00af644d7c92",
    "createdByAppId": "f98c895e-6ce2-4f5b-a31b-da7e48f25daa",
    "displayName": "My Agent Identity",
    "instanceMode": "multiInstance",
    "servicePrincipalType": "ServiceIdentity",
    "tags": [],
    "agentIdentityBlueprintId": "65415bb1-9267-4313-bbf5-ae259732ee12"
}

Example 2: Create a single-instance agent identity

The blueprint identified by agentIdentityBlueprintId was created with isSingleInstance set to true.

Request

POST https://graph.microsoft.com/beta/servicePrincipals/microsoft.graph.agentIdentity
Content-Type: application/json

{
  "displayName": "Contoso Single-Instance Agent",
  "agentIdentityBlueprintId": "65415bb1-9267-4313-bbf5-ae259732ee12",
  "sponsors@odata.bind": [
    "https://graph.microsoft.com/v1.0/users/acc9f0a1-9075-464f-9fe7-049bf1ae6481"
  ]
}

Response

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

{
  "@odata.type": "#microsoft.graph.agentIdentity",
  "id": "59e617e5-e447-4adc-8b88-00af644d7c92",
  "displayName": "Contoso Single-Instance Agent",
  "agentIdentityBlueprintId": "65415bb1-9267-4313-bbf5-ae259732ee12",
  "instanceMode": "singleInstance",
  "accountEnabled": true,
  "createdDateTime": "2026-11-02T23:00:00Z"
}
  • Last updated on