Skip to content

agentidentity-list.md

Latest commit

 

History

History
129 lines (94 loc) · 4.89 KB

agentidentity-list.md

File metadata and controls

129 lines (94 loc) · 4.89 KB
title List agentIdentity objects
description Retrieve a list of agentIdentity objects.
author zallison22
ms.date 10/27/2025
ms.localizationpriority medium
ms.subservice entra-agent-id
doc_type apiPageType

List agentIdentity objects

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-agentid-apis-write]

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

HTTP

GET https://graph.microsoft.com/beta/servicePrincipals/microsoft.graph.agentIdentity

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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": []
    }
  ]
}