Edit

Delete 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.

Delete a agentIdentity object. When deleted, agentIdentities are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.

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 permission Higher privileged permissions
Delegated (work or school account) AgentIdentity.DeleteRestore.All Not available
Delegated (personal Microsoft account) Not supported. Not supported.
Application AgentIdentity.DeleteRestore.All, AgentIdentity.CreateAsManager Not available

Important

  • A principal who creates a blueprint or blueprint principal is assigned as the owner. Owners can create agent identities and modify only the resources they own, even if they aren't 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 built-in roles, which provide only the least privilege necessary:
    • Agent ID Administrator.
    • Agent ID Developer - Create agent identity blueprints and blueprint principals.

HTTP request

DELETE /servicePrincipals/{id}/microsoft.graph.agentIdentity

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns 204 No Content response code. It doesn't return anything in the response body.

Examples

Request

The following example shows a request.

DELETE https://graph.microsoft.com/beta/servicePrincipals/{id}/microsoft.graph.agentIdentity

Response

The following example shows the response.

HTTP/1.1 204 No Content