Edit

Share via

List agentIdentity objects

Namespace: microsoft.graph

Retrieve a list of agentIdentity objects. Does not return other types of service principal objects.

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) Application.Read.All Application.ReadWrite.All, AgentIdentity.Read.All, AgentIdentityBlueprintPrincipal.Read.All, Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Application.Read.All Application.ReadWrite.OwnedBy, AgentIdentity.Read.All, AgentIdentityBlueprintPrincipal.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

Important

For delegated access 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. The principal with this role is assigned ownership of the blueprint or blueprint principal they create and can perform write operations on the resources they own.

Known issue: If the client is granted either the Directory.AccessAsUser.All or Directory.ReadWrite.All permission, the client's permissions to create, update, and delete Agent IDs are ignored, which can cause requests to fail with 403 Forbidden error. To resolve this issue, remove these permissions from the client, request new access tokens, and retry the request.

HTTP request

GET /servicePrincipals/microsoft.graph.agentIdentity

Optional query parameters

This method supports the $count, $expand, $filter, $orderby, $search, $select, and $top OData query parameters to help customize the response. The default and maximum page size is 100 agent identity objects. Some queries are supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
ConsistencyLevel eventual. This header and $count are required when using $search, or in specific usage of $filter. For more information about the use of ConsistencyLevel and $count, see Advanced query capabilities on directory objects.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of agentIdentity objects in the response body.

Examples

Request

GET https://graph.microsoft.com/v1.0/servicePrincipals/microsoft.graph.agentIdentity

Response

The following example shows the response.

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

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

{
  "value": [
    {
      "id": "1b7313c4-05d0-4a08-88e3-7b76c003a0a2",
      "displayName": "My Agent Identity",
      "createdDateTime": "2019-09-17T19:10:35.2742618Z",
      "createdByAppId": "00001111-aaaa-2222-bbbb-3333cccc4444",
      "agentIdentityBlueprintId": "00001111-aaaa-2222-bbbb-3333cccc4444",
      "accountEnabled": true,
      "disabledByMicrosoftStatus": null,
      "servicePrincipalType": "ServiceIdentity",
      "tags": []
    }
  ]
}
  • Last updated on