Enable authentication and authorization in Azure Container Apps with Microsoft Entra ID

Artikel
06/14/2024

This article shows you how to configure authentication for Azure Container Apps so that your app signs in users with the Microsoft identity platform as the authentication provider.

The Container Apps Authentication feature can automatically create an app registration with the Microsoft identity platform. You can also use a registration that you or a directory admin creates separately.

Create a new app registration automatically
Use an existing registration created separately

Option 1: Create a new app registration automatically

This option is designed to make enabling authentication simple and requires just a few steps.

Sign in to the Azure portal and navigate to your app.
Select Authentication in the menu on the left. Select Add identity provider.
Select Microsoft in the identity provider dropdown. The option to create a new registration is selected by default. You can change the name of the registration or the supported account types.

A client secret is created and stored as a secret in the container app.
If you're configuring the first identity provider for this application, you're prompted with a Container Apps authentication settings section. Otherwise, you move on to the next step.

These options determine how your application responds to unauthenticated requests, and the default selections redirect all requests to sign in with this new provider. You can customize this behavior now or adjust these settings later from the main Authentication screen by choosing Edit next to Authentication settings. To learn more about these options, see Authentication flow.
(Optional) Select Next: Permissions and add any scopes needed by the application. These are added to the app registration, but you can also change them later.
Select Add.

You're now ready to use the Microsoft identity platform for authentication in your app. The provider is listed on the Authentication screen. From there, you can edit or delete this provider configuration.

Option 2: Use an existing registration created separately

You can also manually register your application for the Microsoft identity platform, customize the registration, and configure Container Apps Authentication with the registration details. This approach is useful when you want to use an app registration from a different Microsoft Entra tenant other than the one in which your application is defined.

Create an app registration in Microsoft Entra ID for your container app

First, you create your app registration. As you do so, collect the following information that you need later when you configure the authentication in the container app:

Client ID
Tenant ID
Client secret (optional)
Application ID URI

To register the app, perform the following steps:

Sign in to the Azure portal, search for and select Container Apps, and then select your app. Note your app's URL. You use it to configure your Microsoft Entra app registration.
From the portal menu, select Microsoft Entra ID, then go to the App registrations tab and select New registration.
In the Register an application page, enter a Name for your app registration.
In Redirect URI, select Web and type <app-url>/.auth/login/aad/callback. For example, https://<hostname>.azurecontainerapps.io/.auth/login/aad/callback.
Select Register.
After the app registration is created, copy the Application (client) ID and the Directory (tenant) ID for later.
Select Authentication. Under Implicit grant and hybrid flows, enable ID tokens to allow OpenID Connect user sign-ins from Container Apps. Select Save.
(Optional) Select Branding. In Home page URL, enter the URL of your container app and select Save.
Select Expose an API, and select Set next to Application ID URI. The ID value uniquely identifies your application when it's used as a resource, which allows requested tokens to grant access. The value is also used as a prefix for scopes you create.

For a single-tenant app, you can use the default value, which is in the form api://<application-client-id>. You can also specify a more readable URI like https://contoso.com/api based on one of the verified domains for your tenant. For a multitenant app, you must provide a custom URI. To learn more about accepted formats for App ID URIs, see the app registrations best practices reference.

The value is automatically saved.
Select Add a scope.
1. In Add a scope, the Application ID URI is the value you set in a previous step. Select Save and continue.
2. In Scope name, enter user_impersonation.
3. In the text boxes, enter the consent scope name and description you want users to see on the consent page. For example, enter Access <application-name>.
4. Select Add scope.
(Optional) To create a client secret, select Certificates & secrets > Client secrets > New client secret. Enter a description and expiration and select Add. Copy the client secret value shown on the page as the site won't display it to you again.
(Optional) To add multiple Reply URLs, select Authentication.

Enable Microsoft Entra ID in your container app

Sign in to the Azure portal and navigate to your app.
Select Authentication in the menu on the left. Select Add identity provider.
Select Microsoft in the identity provider dropdown.

For App registration type, you can choose to Pick an existing app registration in this directory which automatically gathers the necessary app information. If your registration is from another tenant or you don't have permission to view the registration object, choose Provide the details of an existing app registration. For this option, you need to fill in the following configuration details:

Field	Description
Application (client) ID	Use the Application (client) ID of the app registration.
Client Secret	Use the client secret you generated in the app registration. With a client secret, hybrid flow is used and the app returns access and refresh tokens. When the client secret isn't set, implicit flow is used and only an ID token is returned. The provider sends the tokens and they're stored in the EasyAuth token store.
Issuer Url	Use `<authentication-endpoint>/<TENANT-ID>/v2.0`, and replace <authentication-endpoint> with the authentication endpoint for your cloud environment (for example, "https://login.microsoftonline.com" for global Azure), also replacing <TENANT-ID> with the Directory (tenant) ID in which the app registration was created. This value is used to redirect users to the correct Microsoft Entra tenant, and to download the appropriate metadata to determine the appropriate token signing keys and token issuer claim value for example. For applications that use Azure AD v1, omit `/v2.0` in the URL.
Allowed Token Audiences	The configured Application (client) ID is always implicitly considered to be an allowed audience. If this value refers to a cloud or server app and you want to accept authentication tokens from a client container app (the authentication token can be retrieved in the `X-MS-TOKEN-AAD-ID-TOKEN` header), add the Application (client) ID of the client app here.

The client secret is stored as secrets in your container app.

If this is the first identity provider configured for the application, you're also prompted with a Container Apps authentication settings section. Otherwise, you move on to the next step.

These options determine how your application responds to unauthenticated requests, and the default selections will redirect all requests to sign in with this new provider. You can change customize this behavior now or adjust these settings later from the main Authentication screen by choosing Edit next to Authentication settings. To learn more about these options, see Authentication flow.
Select Add.

Configure client apps to access your container app

In the prior section, you registered your container app to authenticate users. In this section, you register native client or daemon apps. They can then request access to APIs exposed by your container app on behalf of users or themselves. Completing the steps in this section isn't required if you only wish to authenticate users.

Native client application

You can register native clients to request access your container app's APIs on behalf of a signed in user.

In the Azure portal, select Microsoft Entra ID > Add > App registrations.
In the Register an application page, enter a Name for your app registration.
In Redirect URI, select Public client (mobile & desktop) and type the URL <app-url>/.auth/login/aad/callback. For example, https://<hostname>.azurecontainerapps.io/.auth/login/aad/callback.

Note

For a Microsoft Store application, use the package SID as the URI instead.
Select Create.
After the app registration is created, copy the value of Application (client) ID.
Select API permissions > Add a permission > My APIs.
Select the app registration you created earlier for your container app. If you don't see the app registration, make sure that you added the user_impersonation scope in Create an app registration in Microsoft Entra ID for your container app.
Under Delegated permissions, select user_impersonation, and then select Add permissions.

In this section, you configured a native client application that can request access your container app on behalf of a user.

Daemon client application (service-to-service calls)

Your application can acquire a token to call a Web API hosted in your container app on behalf of itself (not on behalf of a user). This scenario is useful for non-interactive daemon applications that perform tasks without a logged in user. It uses the standard OAuth 2.0 client credentials grant.

In the Azure portal, select Microsoft Entra ID > Add > App registrations.
In the Register an application page, enter a Name for your daemon app registration.
For a daemon application, you don't need a Redirect URI so you can keep that empty.
Select Create.
After the app registration is created, copy the value of Application (client) ID.
Select Certificates & secrets > New client secret > Add. Copy the client secret value shown in the page. It isn't shown again.

You can now request an access token using the client ID and client secret by setting the resource parameter to the Application ID URI of the target app. The resulting access token can then be presented to the target app using the standard OAuth 2.0 Authorization header, and Container Apps Authentication / Authorization validates and uses the token as usual to indicate that the caller (an application in this case, not a user) is authenticated.

This process allows any client application in your Microsoft Entra tenant to request an access token and authenticate to the target app. If you also want to enforce authorization to allow only certain client applications, you must adjust the configuration.

Define an App Role in the manifest of the app registration representing the container app you want to protect.
On the app registration representing the client that needs to be authorized, select API permissions > Add a permission > My APIs.
Select the app registration you created earlier. If you don't see the app registration, make sure that you've added an App Role.
Under Application permissions, select the App Role you created earlier, and then select Add permissions.
Make sure to select Grant admin consent to authorize the client application to request the permission.
Similar to the previous scenario (before any roles were added), you can now request an access token for the same target resource, and the access token includes a roles claim containing the App Roles that were authorized for the client application.
Within the target Container Apps code, you can now validate that the expected roles are present in the token. The Container Apps auth layer doesn't perform the validation steps. For more information, see Access user claims.

In this section, you configured a daemon client application that can access your container app using its own identity.

Working with authenticated users

Use the following guides for details on working with authenticated users.

Next steps

Authentication and authorization overview

Dela via