You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/app-service/configure-authentication-user-identities.md
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,31 @@
2
2
title: Work with User Identities in AuthN/AuthZ
3
3
description: Learn how to access user identities when you use the built-in authentication and authorization in Azure App Service.
4
4
ms.topic: how-to
5
-
ms.date: 07/01/2025
5
+
ms.date: 07/02/2025
6
6
ms.custom: AppServiceIdentity
7
7
author: cephalin
8
8
ms.author: cephalin
9
9
---
10
10
11
11
# Work with user identities in Azure App Service authentication
12
12
13
-
This article shows you how to work with user identities when you use built-in [authentication and authorization in Azure App Service](overview-authentication-authorization.md).
13
+
This article shows you how to work with user identities when you use [built-in authentication and authorization](overview-authentication-authorization.md) in Azure App Service.
14
+
15
+
## Prerequisites
16
+
17
+
A web application running on Azure App Service that has the [App Service authentication/authorization module enabled](scenario-secure-app-authentication-app-service.md).
14
18
15
19
## Access user claims in app code
16
20
17
-
Your app's authenticated end users or client applications make claims in incoming tokens. App Service makes the claims available to your code by injecting them into request headers. External requests aren't allowed to set these headers, so they're present only if set by App Service.
21
+
Your app's authenticated end users or client applications make claims in incoming tokens. App Service makes the claims available to your code by injecting them into request headers. External requests aren't allowed to set these headers, so they're present only if App Service sets them.
18
22
19
-
You can use the claims information that App Service authentication makes available to perform authorization checks in your app code. Code in any language or framework can get needed information from the request headers. Some code frameworks provide extra options that might be more convenient. See [Framework-specific alternatives](#framework-specific-alternatives).
23
+
You can use the claims information that App Service authentication provides to perform authorization checks in your app code. Code in any language or framework can get needed information from the request headers. Some code frameworks provide extra options that might be more convenient. See [Framework-specific alternatives](#framework-specific-alternatives).
20
24
21
25
The following table describes some example headers:
|`X-MS-CLIENT-PRINCIPAL`| A Base64-encoded JSON representation of available claims. For more information, see [Decode the X-MS-CLIENT-PRINCIPAL header](#decode-the-client-principal-header). |
29
+
|`X-MS-CLIENT-PRINCIPAL`| A Base64-encoded JSON representation of available claims. For more information, see [Decode the client principal header](#decode-the-client-principal-header). |
26
30
|`X-MS-CLIENT-PRINCIPAL-ID`| An identifier that the identity provider sets for the caller. |
27
31
|`X-MS-CLIENT-PRINCIPAL-NAME`| A human-readable name that the identity provider sets for the caller, such as an email address or user principal name. |
28
32
|`X-MS-CLIENT-PRINCIPAL-IDP`| The name of the identity provider that App Service authentication uses. |
@@ -32,13 +36,12 @@ Similar headers expose [provider tokens](configure-authentication-oauth-tokens.m
32
36
> [!NOTE]
33
37
> App Service makes the request headers available to all language frameworks. Different language frameworks might present these headers to the app code in different formats, such as lowercase or title case.
34
38
35
-
<aname="decode-the-client-principal-header"></a>
36
-
### Decode the X-MS-CLIENT-PRINCIPAL header
39
+
### Decode the client principal header
37
40
38
41
The `X-MS-CLIENT-PRINCIPAL` header contains the full set of available claims in Base64-encoded JSON. To process this header, your app must decode the payload and iterate through the `claims` array to find relevant claims.
39
42
40
43
> [!NOTE]
41
-
> These claims undergo a default claims-mapping process, so some might have different names than if you process the token directly.
44
+
> These claims undergo a default claims-mapping process, so some names might be different than they appear in the tokens.
42
45
43
46
The decoded payload structure is as follows:
44
47
@@ -56,6 +59,8 @@ The decoded payload structure is as follows:
|`auth_typ`| string | The name of the identity provider that App Service authentication uses. |
@@ -65,7 +70,7 @@ The decoded payload structure is as follows:
65
70
|`name_typ`| string | The name claim type, which is typically a URI that provides scheme information about the `name` claim if one is defined. |
66
71
|`role_typ`| string | The role claim type, which is typically a URI that provides scheme information about the `role` claim if one is defined. |
67
72
68
-
For convenience, you can convert claims into a representation that the app's language framework uses. The following example uses C# to construct a [`ClaimsPrincipal`](/dotnet/api/system.security.claims.claimsprincipal) type for the app to use.
73
+
For convenience, you can convert claims into a representation that the app's language framework uses. The following C# example constructs a [`ClaimsPrincipal`](/dotnet/api/system.security.claims.claimsprincipal) type for the app to use.
69
74
70
75
```csharp
71
76
usingSystem;
@@ -113,7 +118,7 @@ public static class ClaimsPrincipalParser
The rest of this function performs this conversion to create a `ClaimsPrincipal` that can be used in other .NET code.
121
+
The rest of the function performs this conversion to create a `ClaimsPrincipal` that can be used in other .NET code.
117
122
118
123
```csharp
119
124
var identity = new ClaimsIdentity(principal.IdentityProvider, principal.NameClaimType, principal.RoleClaimType);
@@ -126,15 +131,15 @@ The rest of this function performs this conversion to create a `ClaimsPrincipal`
126
131
127
132
### Framework-specific alternatives
128
133
129
-
- For ASP.NET 4.6 apps, App Service populates [`ClaimsPrincipal.Current`](/dotnet/api/system.security.claims.claimsprincipal.current) with the authenticated user's claims. You can follow the standard .NET code pattern, including the [`Authorize`] attribute.
134
+
- For ASP.NET 4.6 apps, App Service populates [`ClaimsPrincipal.Current`](/dotnet/api/system.security.claims.claimsprincipal.current) with the authenticated user's claims. You can follow the standard .NET code pattern, including the `[Authorize]` attribute.
130
135
136
+
`ClaimsPrincipal.Current` isn't populated for .NET code in [Azure Functions](../azure-functions/functions-overview.md), but you can still find the user claims in the request headers, or get the `ClaimsPrincipal` object from the request context or through a binding parameter. For more information, see [Work with client identities in Azure Functions](../azure-functions/functions-bindings-http-webhook-trigger.md#working-with-client-identities).
137
+
131
138
- For PHP apps, App Service similarly populates the `_SERVER['REMOTE_USER']` variable.
132
139
133
-
- For Java apps, the claims are [accessible from the Tomcat servlet](configure-language-java-security.md#authenticate-users-easy-auth).
134
-
135
-
- For [Azure Functions](../azure-functions/functions-overview.md), `ClaimsPrincipal.Current` isn't populated for .NET code, but you can still find the user claims in the request headers, or get the `ClaimsPrincipal` object from the request context or through a binding parameter. For more information, see [Work with client identities in Azure Functions](../azure-functions/functions-bindings-http-webhook-trigger.md#working-with-client-identities).
140
+
- For Java apps, the claims are accessible from the [Tomcat servlet](configure-language-java-security.md?pivots=java-tomcat#authenticate-users-easy-auth).
136
141
137
-
- For .NET Core, [`Microsoft.Identity.Web`](https://www.nuget.org/packages/Microsoft.Identity.Web/) supports populating the current user with App Service authentication. For more information, see [Integration with Azure App Services authentication of web Apps running with Microsoft.Identity.Web](https://github.com/AzureAD/microsoft-identity-web/wiki/1.2.0#integration-with-azure-app-services-authentication-of-web-apps-running-with-microsoftidentityweb). For a demonstration of a web app accessing Microsoft Graph, see [Tutorial: Access Microsoft Graph from a secured .NET app as the user](scenario-secure-app-access-microsoft-graph-as-user.md).
142
+
- For .NET Core, [`Microsoft.Identity.Web`](https://www.nuget.org/packages/Microsoft.Identity.Web/) supports populating the current user with App Service authentication. For more information, see [Integration with Azure App Services authentication of web apps running with Microsoft.Identity.Web](https://github.com/AzureAD/microsoft-identity-web/wiki/1.2.0#integration-with-azure-app-services-authentication-of-web-apps-running-with-microsoftidentityweb). For a demonstration of a web app accessing Microsoft Graph, see [Tutorial: Access Microsoft Graph from a secured .NET app as the user](scenario-secure-app-access-microsoft-graph-as-user.md).
138
143
139
144
> [!NOTE]
140
145
> For claims mapping to work, you must enable the [token store](overview-authentication-authorization.md#token-store) for your app.
0 commit comments