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

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

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.ServicePrincipals["{servicePrincipal-id}"].GetAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
servicePrincipals, err := graphClient.ServicePrincipals().ByServicePrincipalId("servicePrincipal-id").Get(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ServicePrincipal result = graphClient.servicePrincipals().byServicePrincipalId("{servicePrincipal-id}").get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let agentIdentity = await client.api('/servicePrincipals/microsoft.graph.agentIdentity')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->servicePrincipals()->byServicePrincipalId('servicePrincipal-id')->get()->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Applications

Get-MgServicePrincipal -ServicePrincipalId $servicePrincipalId

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.service_principals.by_service_principal_id('servicePrincipal-id').get()

For details about how to add the SDK to your project and create an authProvider instance, see the 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": []
    }
  ]
}

Tilbakemeldinger

Var denne siden nyttig?

Last updated on 2026-03-21

List agentIdentity objects

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Request

Response

Tilbakemeldinger

Flere ressurser