Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Read the properties and relationships of agentIdentity object.
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.Read.All | Application.Read.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | AgentIdentity.Read.All, AgentIdentity.CreateAsManager | Application.Read.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/{id}/microsoft.graph.agentIdentity
Optional query parameters
This method supports the $select and $expand OData query parameters to help customize the response.
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 a 200 OK response code and an agentIdentity object in the response body.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/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
{
"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": []
}