Skip to content

Commit 1792617

Browse files
Learn Build Service GitHub AppLearn Build Service GitHub App
authored andcommitted
Merging changes synced from https://github.com/MicrosoftDocs/entra-docs-pr (branch live)
2 parents bef6bfc + 0bf553f commit 1792617

22 files changed

Lines changed: 233 additions & 53 deletions

docs/agent-id/agent-oauth-protocols.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.reviewer: jmprieur
1111

1212
# Authentication protocols in agents
1313

14-
Agents use OAuth 2.0 protocols with specialized token exchange patterns enabled by Federated Identity Credentials (FIC). All agent auth flows involve multi-stage token exchanges where the agent identity blueprint impersonates the agent identity to perform operations. This article explains the authentication protocols and token flows used by agents. It covers delegation scenarios, autonomous operations, and federated identity credential patterns. Microsoft recommends that you use our SDKs like [Microsoft Entra SDK for Agent ID](https://aka.ms/entra/sdk/agentid) since implementing these protocol steps isn't easy.
14+
Agents use OAuth 2.0 protocols with specialized token exchange patterns enabled by Federated Identity Credentials (FIC). All agent auth flows involve multi-stage token exchanges where the agent identity blueprint impersonates the agent identity to perform operations. This article explains the authentication protocols and token flows used by agents. It covers delegation scenarios, autonomous operations, and federated identity credential patterns. Microsoft recommends that you use our SDKs like [Microsoft Entra ID Auth SDK (sidecar)](https://aka.ms/entra/sdk/agentid) since implementing these protocol steps isn't easy.
1515

1616
All agent entities are confidential clients that can also serve as APIs for On-Behalf-Of scenarios. Interactive flows aren't supported for any agent entity type, ensuring that all authentication occurs through programmatic token exchanges rather than user interaction flows.
1717

docs/agent-id/authentication-with-auth-sdk-sidecar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ The [Microsoft Entra Agent ID sidecar samples](https://github.com/microsoft/entr
7777

7878
## Related content
7979

80-
- [Microsoft Entra SDK for Agent ID documentation](/entra/msidweb/agent-id-sdk/overview)
81-
- [Acquire tokens and call downstream APIs with Microsoft Entra SDK for Agent ID](microsoft-entra-sdk-for-agent-identities.md)
80+
- [Microsoft Entra ID Auth SDK (sidecar) documentation](/entra/msidweb/agent-id-sdk/overview)
81+
- [Acquire tokens and call downstream APIs with Microsoft Entra ID Auth SDK (sidecar)](microsoft-entra-sdk-for-agent-identities.md)
8282
- [Microsoft Entra Agent ID design patterns](concept-agent-id-design-patterns.md)
8383
- [Agent identity blueprints](agent-blueprint.md)
8484
- [Autonomous agent app OAuth flow](agent-autonomous-app-oauth-flow.md)

docs/agent-id/autonomous-agent-authentication-authorization-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ You can also use the agent's user account principal name instead of the object I
533533
- [Call Microsoft Graph API](call-api-microsoft-graph.md)
534534
- [Call custom APIs](call-api-custom.md)
535535
- [Call Azure services](call-api-azure-services.md)
536-
- [Acquire token using Microsoft Entra SDK for agent ID](./microsoft-entra-sdk-for-agent-identities.md)
536+
- [Acquire token using Microsoft Entra ID Auth SDK (sidecar)](./microsoft-entra-sdk-for-agent-identities.md)
537537
- [Microsoft Graph permissions reference](/graph/permissions-reference)
538538
- [Permissions and consent in the Microsoft identity platform](/entra/identity-platform/permissions-consent-overview)
539539
- [Agent's user account flow in agents](agent-user-oauth-flow.md)

docs/agent-id/configure-third-party-agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ If you run into problems during integration, use the following guidance to ident
198198

199199
## Related content
200200

201-
- [Configure SDK for agent identities](microsoft-entra-sdk-for-agent-identities.md)
201+
- [Configure Entra ID Auth SDK (sidecar) for agent identities](microsoft-entra-sdk-for-agent-identities.md)
202202
- [Call Microsoft Graph API](call-api-microsoft-graph.md)
203203
- [Call custom APIs](call-api-custom.md)
204204
- [Call Azure services](call-api-azure-services.md)

docs/agent-id/faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,6 @@ sections:
127127
128128
Microsoft.Identity.Web provides higher-level APIs for acquiring tokens for agent identities in .NET applications. Use the [Microsoft.Identity.Web.AgentIdentities](https://github.com/AzureAD/microsoft-identity-web/blob/master/src/Microsoft.Identity.Web.AgentIdentities/README.AgentIdentities.md) package to simplify managing agent identities.
129129
130-
The Microsoft Entra SDK container wraps Microsoft.Identity.Web as a web service deployed as a sidecar container. Use this option when your agent runs on Kubernetes and/or isn't built in .NET. For more information, see [Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/overview).
130+
The Microsoft Entra SDK container wraps Microsoft.Identity.Web as a web service deployed as a sidecar container. Use this option when your agent runs on Kubernetes and/or isn't built in .NET. For more information, see [Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/overview).
131131
132132
Microsoft Graph APIs provide agent identity management when the other options don't fit your scenario. For more information, see [Microsoft Graph API for agent identity blueprints](/graph/api/resources/agentidentityblueprint).

docs/agent-id/includes/call-api-common-dotnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.topic: include
55
# To guide users on how to call APIs using agent identities in .NET.
66
---
77

8-
To call an API from an agent, you need to obtain an access token that the agent can use to authenticate itself to the API. We recommend using the *Microsoft.Identity.Web* SDK for .NET to call your web APIs. This SDK simplifies the process of acquiring and validating tokens. For other languages, use the [Microsoft Entra agent SDK for agent ID](/entra/msidweb/agent-id-sdk/overview).
8+
To call an API from an agent, you need to obtain an access token that the agent can use to authenticate itself to the API. We recommend using the *Microsoft.Identity.Web* SDK for .NET to call your web APIs. This SDK simplifies the process of acquiring and validating tokens. For other languages, use the [Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/overview).
99

1010
## Prerequisites
1111

docs/agent-id/includes/use-microsoft-libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ ms.topic: include
66
---
77

88
> [!WARNING]
9-
> Microsoft recommends using the approved SDKs like Microsoft.Identity.Web and Microsoft Agent ID SDK libraries to implement these protocols. Manual implementation of these protocols is complex and error-prone, and using the SDKs helps ensure security and compliance with best practices.
9+
> Microsoft recommends using the approved SDKs like Microsoft.Identity.Web and Microsoft Entra ID Auth SDK (sidecar) libraries to implement these protocols. Manual implementation of these protocols is complex and error-prone, and using the SDKs helps ensure security and compliance with best practices.

docs/agent-id/index.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ sections:
6868
summary: Use an AI coding agent to automate the full Agent ID onboarding workflow, from blueprint creation to agent provisioning.
6969
url: ./agent-id-ai-guided-setup.md
7070
- componentType: summary-card
71-
title: Microsoft Entra SDK for agents
71+
title: Microsoft Entra ID Auth SDK (sidecar)
7272
summary: Integrate agent authentication and authorization with familiar SDKs and developer tools.
7373
url: ./microsoft-entra-sdk-for-agent-identities.md
7474
- componentType: summary-card

docs/agent-id/key-concepts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ When a blueprint is added to a tenant, Microsoft Entra creates a corresponding p
3333

3434
### Traditional service principal (not recommended for AI agents)
3535

36-
Traditional service principals were designed for static, deterministic workloads. Microsoft Entra Agent ID exists because service principals lack the governance infrastructure AI agents need.There's no enforced sponsorship, no agent-aware audit entries, and no blueprint-managed lifecycle. For more information, see [Agent identities, service principals, and applications](agent-service-principals.md).
36+
Traditional service principals were designed for static, deterministic workloads. Microsoft Entra Agent ID exists because service principals lack the governance infrastructure AI agents need. There's no enforced sponsorship, no agent-aware audit entries, and no blueprint-managed lifecycle. For more information, see [Agent identities, service principals, and applications](agent-service-principals.md).
3737

3838
### Regular user account (not recommended for AI agents)
3939

@@ -55,9 +55,9 @@ The agent identity platform introduces an administrative model that separates te
5555

5656
For more information, see [Administrative relationships for agent identities (Owners, sponsors, and managers)](agent-owners-sponsors-managers.md)
5757

58-
## Microsoft Entra SDK for agent ID
58+
## Microsoft Entra ID Auth SDK (sidecar)
5959

60-
The Microsoft Entra SDK for Agent ID is a containerized web service that handles token acquisition, validation, and secure downstream API calls for agents registered in the Microsoft identity platform. It runs as a companion container alongside your application, allowing you to offload identity logic to a dedicated service. For more information, see [Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/overview).
60+
The Microsoft Entra ID Auth SDK (sidecar) is a containerized web service that handles token acquisition, validation, and secure downstream API calls for agents registered in the Microsoft identity platform. It runs as a companion container alongside your application, allowing you to offload identity logic to a dedicated service. For more information, see [Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/overview).
6161

6262
## Related content
6363

docs/agent-id/microsoft-entra-sdk-for-agent-identities.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
---
2-
title: Acquire tokens and call downstream APIs with Microsoft Entra SDK for Agent ID
2+
title: Acquire tokens and call downstream APIs with Microsoft Entra ID Auth SDK (sidecar)
33
titleSuffix: Microsoft Entra Agent ID
4-
description: Learn how autonomous agents acquire tokens using the Microsoft Entra SDK for Agent ID to call downstream APIs independently.
4+
description: Learn how autonomous agents acquire tokens using the Microsoft Entra ID Auth SDK (sidecar) to call downstream APIs independently.
55
ms.topic: how-to
66
ms.date: 11/05/2025
77
ms.reviewer: jmprieur
8-
#Customer intent: As a developer building autonomous agents, I want to acquire tokens using the Microsoft Entra SDK for Agent ID so that my agents can independently call downstream APIs with proper authentication.
8+
#Customer intent: As a developer building autonomous agents, I want to acquire tokens using the Microsoft Entra ID Auth SDK (sidecar) so that my agents can independently call downstream APIs with proper authentication.
99
---
1010

11-
# Acquire tokens and call downstream APIs with Microsoft Entra SDK for Agent ID
11+
# Acquire tokens and call downstream APIs with Microsoft Entra ID Auth SDK (sidecar)
1212

13-
The Microsoft Entra SDK for Agent ID is a containerized web service that handles token acquisition, validation, and downstream API calls for agents. This SDK communicates with your application through HTTP APIs, providing consistent integration patterns regardless of your technology stack. Instead of embedding identity logic directly in your application code, the Microsoft Entra SDK for Agent ID manages token acquisition, validation, and API calls through standard HTTP requests.
13+
The Microsoft Entra ID Auth SDK (sidecar) is a containerized web service that handles token acquisition, validation, and downstream API calls for agents. This SDK communicates with your application through HTTP APIs, providing consistent integration patterns regardless of your technology stack. Instead of embedding identity logic directly in your application code, the Microsoft Entra ID Auth SDK (sidecar) manages token acquisition, validation, and API calls through standard HTTP requests.
1414

1515
## Prerequisites
1616

1717
Before you begin, ensure you have:
1818

19-
- [Set up the Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/installation)
19+
- [Set up the Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/installation)
2020
- [An agent identity](./create-delete-agent-identities.md). Record the agent identity client ID.
2121
- [An agent identity blueprint](./create-blueprint.md). Record the agent identity blueprint client ID.
2222
- Necessary [permissions configured in Microsoft Entra ID](grant-agent-access-microsoft-365.md)
2323

2424
## Deploy your containerized service
2525

26-
Deploy the Microsoft Entra SDK for Agent ID as a containerized service in your environment. Follow the instructions in the [Set up the Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/installation) guide to configure the service with your agent identity details.
26+
Deploy the Microsoft Entra ID Auth SDK (sidecar) as a containerized service in your environment. Follow the instructions in the [Set up the Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/installation) guide to configure the service with your agent identity details.
2727

28-
## Configure your Microsoft Entra SDK for Agent ID settings
28+
## Configure your Microsoft Entra ID Auth SDK (sidecar) settings
2929

30-
Follow these steps to configure your Microsoft Entra SDK for Agent ID settings:
30+
Follow these steps to configure your Microsoft Entra ID Auth SDK (sidecar) settings:
3131

3232
[!INCLUDE [Dont use secrets](./includes/do-not-use-secrets.md)]
3333

@@ -37,19 +37,19 @@ Follow these steps to configure your Microsoft Entra SDK for Agent ID settings:
3737

3838
1. If you're calling a downstream API, ensure that the necessary permissions are granted. Calling a custom web API requires you to provide the API registration details in the SDK configuration.
3939

40-
For more information, see [Configure your Microsoft Entra SDK for Agent ID settings](/entra/msidweb/agent-id-sdk/configuration).
40+
For more information, see [Configure your Microsoft Entra ID Auth SDK (sidecar) settings](/entra/msidweb/agent-id-sdk/configuration).
4141

42-
## Acquire tokens using the Microsoft Entra SDK for Agent ID
42+
## Acquire tokens using the Microsoft Entra ID Auth SDK (sidecar)
4343

44-
These are the steps to acquire tokens using the Microsoft Entra SDK for Agent ID:
44+
These are the steps to acquire tokens using the Microsoft Entra ID Auth SDK (sidecar):
4545

46-
1. Acquire token using the Microsoft Entra SDK for Agent ID. This varies based on whether the agent is operating autonomously or on behalf of a user. There are three scenarios to consider:
46+
1. Acquire token using the Microsoft Entra ID Auth SDK (sidecar). This varies based on whether the agent is operating autonomously or on behalf of a user. There are three scenarios to consider:
4747

4848
- Autonomous agents: Agents operating on their own behalf using service principals created for agents (autonomous).
4949
- Autonomous agent's user account: Agents operating on their own behalf using user principals created specifically for agents (for instance agents having their own mailbox).
5050
- Interactive agents: Agents operating on behalf of human users.
5151

52-
Specify the downstream API by including its name in the request URL based on your agent ID SDK configuration. The authorization header endpoint takes the format `/AuthorizationHeader/{serviceName}` where `serviceName` is the name of the downstream API configured in the SDK settings.
52+
Specify the downstream API by including its name in the request URL based on your Entra ID Auth SDK (sidecar) configuration. The authorization header endpoint takes the format `/AuthorizationHeader/{serviceName}` where `serviceName` is the name of the downstream API configured in the SDK settings.
5353

5454
1. To acquire an app only token for an autonomous agent, you provide the agent identity client ID in the request.
5555

@@ -72,7 +72,7 @@ These are the steps to acquire tokens using the Microsoft Entra SDK for Agent ID
7272
7373
1. For interactive agents, use the on-behalf of flow. The agent first validates the user token granted to it before acquiring the resource token to call the downstream API.
7474
75-
Agent web API receives user token from the calling application and validates the token via the agent ID SDK `/Validate` endpoint
75+
Agent web API receives user token from the calling application and validates the token via the Entra ID Auth SDK (sidecar) `/Validate` endpoint
7676
Acquire token for downstream APIs by calling `/AuthorizationHeader` with only the `AgentIdentity` and the incoming authorization header
7777
7878
```bash
@@ -87,12 +87,12 @@ These are the steps to acquire tokens using the Microsoft Entra SDK for Agent ID
8787
8888
## Call an API
8989
90-
When obtaining the authorization header for calling a downstream API, the Microsoft Entra SDK for Agent ID returns the `Authorization` header value that can be used directly in your API calls.
90+
When obtaining the authorization header for calling a downstream API, the Microsoft Entra ID Auth SDK (sidecar) returns the `Authorization` header value that can be used directly in your API calls.
9191
92-
You can use this header to call the downstream API. The web API should validate the token by calling the `/Validate` endpoint of the Microsoft Entra SDK for Agent ID. This endpoint returns token claims for further authorization decisions.
92+
You can use this header to call the downstream API. The web API should validate the token by calling the `/Validate` endpoint of the Microsoft Entra ID Auth SDK (sidecar). This endpoint returns token claims for further authorization decisions.
9393
9494
## Related content
9595
96-
- [Python implementation of Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/scenarios/using-from-python)
97-
- [TypeScript implementation of Microsoft Entra SDK for Agent ID](/entra/msidweb/agent-id-sdk/scenarios/using-from-typescript)
98-
- [Call a downstream API - Microsoft Entra SDK for agent ID docs](/entra/msidweb/agent-id-sdk/scenarios/call-downstream-api)
96+
- [Python implementation of Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/scenarios/using-from-python)
97+
- [TypeScript implementation of Microsoft Entra ID Auth SDK (sidecar)](/entra/msidweb/agent-id-sdk/scenarios/using-from-typescript)
98+
- [Call a downstream API - Microsoft Entra ID Auth SDK (sidecar) docs](/entra/msidweb/agent-id-sdk/scenarios/call-downstream-api)

0 commit comments

Comments
 (0)