Skip to content

Commit d4e65f2

Browse files
authored
Merge pull request #28319 from microsoftgraph/zallison/agent_apis_to_v1
[v1.0] Promote the agent APIs to v1.0
2 parents 4fbe2d5 + db4102a commit d4e65f2

139 files changed

Lines changed: 6917 additions & 24 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api-reference/beta/api/agentidentity-post-owners.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Add an owner for the [agentIdentity](../resources/agentIdentity.md). Agent identity owners can be users, the agent identity itself, or other service principals.
17+
Add an owner for the [agentIdentity](../resources/agentidentity.md). Agent identity owners can be users, the agent identity itself, or other service principals.
1818

1919
## Permissions
2020

@@ -49,7 +49,7 @@ In the request body, supply a reference to the [directoryObject](../resources/di
4949

5050
## Response
5151

52-
If successful, this method returns a `204 No Content` response code and a [directoryObject](../resources/directoryobject.md) object in the response body.
52+
If successful, this method returns a `204 No Content` response code. No response body is returned.
5353

5454
## Examples
5555

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "Remove agentIdentity owners"
3+
description: "Remove an owner from a agentIdentity."
4+
author: "zallison22"
5+
ms.date: 02/26/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-agent-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# Remove agentIdentity owners
12+
13+
Namespace: microsoft.graph
14+
15+
Remove an owner from a [agentIdentity](../resources/agentidentity.md) object. As a recommended best practice, agent identities should have at least two owners.
16+
17+
## Permissions
18+
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
<!-- {
22+
"blockType": "permissions",
23+
"name": "agentidentity-delete-owners-permissions"
24+
}
25+
-->
26+
[!INCLUDE [permissions-table](../includes/permissions/agentidentity-delete-owners-permissions.md)]
27+
28+
[!INCLUDE [rbac-agentid-apis-write](../includes/rbac-for-apis/rbac-agentid-apis-write.md)]
29+
30+
## HTTP request
31+
32+
<!-- { "blockType": "ignored" } -->
33+
```http
34+
DELETE /servicePrincipals/{id}/microsoft.graph.agentIdentity/owners/{id}/$ref
35+
36+
```
37+
## Request headers
38+
| Name | Description|
39+
|:---- |:---------- |
40+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
41+
42+
## Request body
43+
Don't supply a request body for this method.
44+
45+
## Response
46+
47+
If successful, this method returns a `204 No Content` response code.
48+
49+
## Example
50+
51+
### Request
52+
53+
The following example shows the request.
54+
55+
<!-- {
56+
"blockType": "request",
57+
"name": "agentidentity_delete_owners"
58+
}-->
59+
60+
```http
61+
DELETE https://graph.microsoft.com/v1.0/servicePrincipals/{id}/microsoft.graph.agentIdentity/owners/1511d5e7-c324-4362-ad4b-16c20076e5aa/$ref
62+
63+
```
64+
65+
### Response
66+
67+
The following example shows the response.
68+
<!-- {
69+
"blockType": "response",
70+
"truncated": true
71+
}
72+
-->
73+
``` http
74+
HTTP/1.1 204 No Content
75+
```
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: "Remove agentIdentity sponsors"
3+
description: "Remove a sponsor from an agentIdentity object."
4+
author: "zallison22"
5+
ms.date: 02/26/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-agent-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# Remove agentIdentity sponsors
12+
13+
Namespace: microsoft.graph
14+
15+
Remove a sponsor from a [agentIdentity](../resources/agentidentity.md) object. Agent identities require at least one sponsor to manage the agent identity.
16+
17+
## Permissions
18+
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
<!-- {
22+
"blockType": "permissions",
23+
"name": "agentidentity-delete-sponsors-permissions"
24+
}
25+
-->
26+
[!INCLUDE [permissions-table](../includes/permissions/agentidentity-delete-sponsors-permissions.md)]
27+
28+
[!INCLUDE [rbac-agentid-apis-write](../includes/rbac-for-apis/rbac-agentid-apis-write.md)]
29+
30+
## HTTP request
31+
32+
<!-- {
33+
"blockType": "ignored"
34+
}
35+
-->
36+
``` http
37+
DELETE /servicePrincipals/{id}/microsoft.graph.agentIdentity/sponsors/{sponsorObjectId}/$ref
38+
```
39+
40+
## Request headers
41+
42+
|Name|Description|
43+
|:---|:---|
44+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
45+
46+
## Request body
47+
48+
Don't supply a request body for this method.
49+
50+
## Response
51+
52+
If successful, this method returns a `204 No Content` response code.
53+
54+
## Examples
55+
56+
### Request
57+
58+
The following example shows a request.
59+
<!-- {
60+
"blockType": "request",
61+
"name": "delete_sponsors_from_agentidentity"
62+
}
63+
-->
64+
``` http
65+
DELETE https://graph.microsoft.com/v1.0/servicePrincipals/{id}/microsoft.graph.agentIdentity/sponsors/{sponsorObjectId}/$ref
66+
```
67+
68+
69+
### Response
70+
71+
The following example shows the response.
72+
<!-- {
73+
"blockType": "response",
74+
"truncated": true
75+
}
76+
-->
77+
``` http
78+
HTTP/1.1 204 No Content
79+
```
80+
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: "Delete agentIdentity"
3+
description: "Delete agent identity."
4+
author: "zallison22"
5+
ms.date: 02/26/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-agent-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# Delete agentIdentity
12+
13+
Namespace: microsoft.graph
14+
15+
Delete a [agentIdentity](../resources/agentidentity.md) object. When deleted, agentIdentities are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.
16+
17+
## Permissions
18+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
19+
20+
<!-- { "blockType": "permissions", "name": "agentidentity_delete" } -->
21+
[!INCLUDE [permissions-table](../includes/permissions/agentidentity-delete-permissions.md)]
22+
23+
[!INCLUDE [rbac-agentid-apis-write](../includes/rbac-for-apis/rbac-agentid-apis-write.md)]
24+
25+
## HTTP request
26+
27+
```http
28+
DELETE /servicePrincipals/{id}/microsoft.graph.agentIdentity
29+
```
30+
31+
## Request headers
32+
| Name | Description|
33+
|:---------------|:--------|
34+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
35+
36+
## Request body
37+
Don't supply a request body for this method.
38+
39+
## Response
40+
41+
If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.
42+
43+
## Examples
44+
### Request
45+
The following example shows a request.
46+
47+
<!-- {
48+
"blockType": "request",
49+
"name": "delete_agentIdentity"
50+
}-->
51+
52+
```http
53+
DELETE https://graph.microsoft.com/v1.0/servicePrincipals/{id}/microsoft.graph.agentIdentity
54+
```
55+
56+
### Response
57+
The following example shows the response.
58+
<!-- {
59+
"blockType": "response",
60+
"truncated": true
61+
} -->
62+
63+
```http
64+
HTTP/1.1 204 No Content
65+
```
66+
67+
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
68+
2015-10-25 14:57:30 UTC -->
69+
<!--
70+
{
71+
"type": "#page.annotation",
72+
"description": "Delete agentIdentity",
73+
"keywords": "",
74+
"section": "documentation",
75+
"tocPath": "",
76+
"suppressions": [
77+
]
78+
}
79+
-->
80+
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: "Get agentIdentity"
3+
description: "Read the properties and relationships of agentIdentity object."
4+
author: "zallison22"
5+
ms.date: 02/26/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-agent-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# Get agentIdentity
12+
13+
Namespace: microsoft.graph
14+
15+
Read the properties and relationships of [agentIdentity](../resources/agentidentity.md) object.
16+
17+
## Permissions
18+
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
<!-- {
22+
"blockType": "permissions",
23+
"name": "agentidentity-get-permissions"
24+
}
25+
-->
26+
[!INCLUDE [permissions-table](../includes/permissions/agentidentity-get-permissions.md)]
27+
28+
[!INCLUDE [rbac-agentid-apis-write](../includes/rbac-for-apis/rbac-agentid-apis-write.md)]
29+
30+
## HTTP request
31+
32+
```http
33+
GET /servicePrincipals/{id}/microsoft.graph.agentIdentity
34+
```
35+
36+
## Optional query parameters
37+
38+
This method supports the `$select` and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response.
39+
40+
## Request headers
41+
42+
| Name | Description |
43+
|:---------------|:---------------------------|
44+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
45+
46+
## Request body
47+
48+
Don't supply a request body for this method.
49+
50+
## Response
51+
52+
If successful, this method returns a `200 OK` response code and an [agentIdentity](../resources/agentidentity.md) object in the response body.
53+
54+
## Examples
55+
56+
### Request
57+
58+
The following example shows a request.
59+
<!-- {
60+
"blockType": "request",
61+
"name": "get_agentidentity"
62+
}
63+
-->
64+
``` http
65+
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/microsoft.graph.agentIdentity
66+
```
67+
68+
### Response
69+
70+
The following example shows the response.
71+
>**Note:** The response object shown here might be shortened for readability.
72+
<!-- {
73+
"blockType": "response",
74+
"truncated": true,
75+
"@odata.type": "microsoft.graph.agentIdentity"
76+
}
77+
-->
78+
``` http
79+
HTTP/1.1 200 OK
80+
Content-Type: application/json
81+
82+
{
83+
"id": "1b7313c4-05d0-4a08-88e3-7b76c003a0a2",
84+
"displayName": "My Agent Identity",
85+
"createdDateTime": "2019-09-17T19:10:35.2742618Z",
86+
"createdByAppId": "00001111-aaaa-2222-bbbb-3333cccc4444",
87+
"agentIdentityBlueprintId": "00001111-aaaa-2222-bbbb-3333cccc4444",
88+
"accountEnabled": true,
89+
"disabledByMicrosoftStatus": null,
90+
"servicePrincipalType": "ServiceIdentity",
91+
"tags": []
92+
}
93+
```

0 commit comments

Comments
 (0)