Configure authentication in a sample Android app by using Azure AD B2C

This article uses a sample Android application (Kotlin and Java) to illustrate how to add Azure Active Directory B2C (Azure AD B2C) authentication to your mobile apps.

Overview

OpenID Connect (OIDC) is an authentication protocol that's built on OAuth 2.0. You can use OIDC to securely sign users in to an application. This mobile app sample uses the Microsoft Authentication Library (MSAL) with OIDC authorization code PKCE flow. The MSAL is a Microsoft-provided library that simplifies adding authentication and authorization support to mobile apps.

The sign-in flow involves the following steps:

1. Users open the app and select sign-in.
2. The app opens the mobile device's system browser and starts an authentication request to Azure AD B2C.
3. Users sign up or sign in, reset the password, or sign in with a social account.
4. After users sign in successfully, Azure AD B2C returns an authorization code to the app.
5. The app takes the following actions:
   1. It exchanges the authorization code to an ID token, access token, and refresh token.
   2. It reads the ID token claims.
   3. It stores the tokens in an in-memory cache for later use.

App registration overview

To enable your app to sign in with Azure AD B2C and call a web API, register two applications in the Azure AD B2C directory.

• The mobile application registration enables your app to sign in with Azure AD B2C. During app registration, specify the redirect URI. The redirect URI is the endpoint to which users are redirected by Azure AD B2C after they've authenticated with Azure AD B2C. The app registration process generates an Application ID, also known as the client ID, which uniquely identifies your mobile app (for example, App ID: 1).

• The web API registration enables your app to call a protected web API. The registration exposes the web API permissions (scopes). The app registration process generates an Application ID, which uniquely identifies your web API (for example, App ID: 2). Grant your mobile app (App ID: 1) permissions to the web API scopes (App ID: 2).

The apps registration and application architecture are illustrated in the following diagrams:

Call to a web API

After the authentication is completed, users interact with the app, which invokes a protected web API. The web API uses bearer token authentication. The bearer token is the access token that the app obtained from Azure AD B2C. The app passes the token in the authorization header of the HTTPS request.

Authorization: Bearer <access token>

If the access token's scope doesn't match the web API's scopes, the authentication library obtains a new access token with the correct scopes.

The sign-out flow

The sign-out flow involves the following steps:

1. From the app, users sign out.
2. The app clears its session objects, and the authentication library clears its token cache.
3. The app takes users to the Azure AD B2C sign-out endpoint to terminate the Azure AD B2C session.
4. Users are redirected back to the app.

Prerequisites

A computer that's running:

• Java Development Kit (JDK) 8 or later
• Apache Maven
• Android API level 16 or later
• Android Studio or another code editor

Step 1: Configure your user flow

When users try to sign in to your app, the app starts an authentication request to the authorization endpoint via a user flow. The user flow defines and controls the user experience. After users complete the user flow, Azure AD B2C generates a token and then redirects users back to your application.

If you haven't done so already, create a user flow or a custom policy. Repeat the steps to create three separate user flows as follows:

• A combined Sign in and sign up user flow, such as susi. This user flow also supports the Forgot your password experience.
• A Profile editing user flow, such as edit_profile.
• A Password reset user flow, such as reset_password.

Azure AD B2C prepends B2C_1_ to the user flow name. For example, susi becomes B2C_1_susi.

Step 2: Register mobile applications

Create the mobile app and web API application registration, and specify the scopes of your web API.

Step 2.1: Register the web API app

To create the web API app registration (App ID: 2), follow these steps:

1. Sign in to the Azure portal.

2. Make sure you're using the directory that contains your Azure AD B2C tenant. Select the Directories + subscriptions icon in the portal toolbar.

3. On the Portal settings | Directories + subscriptions page, find your Azure AD B2C directory in the Directory name list, and then select Switch.

4. In the Azure portal, search for and select Azure AD B2C.

5. Select App registrations, and then select New registration.

6. For Name, enter a name for the application (for example, my-api1). Leave the default values for Redirect URI and Supported account types.

7. Select Register.

8. After the app registration is completed, select Overview.

9. Record the Application (client) ID value for later use when you configure the web application.

   

Step 2.2: Configure web API app scopes

1. Select the my-api1 application that you created (App ID: 2) to open its Overview page.

2. Under Manage, select Expose an API.

3. Next to Application ID URI, select the Set link. Replace the default value (GUID) with a unique name (for example, tasks-api), and then select Save.

   When your web application requests an access token for the web API, it should add this URI as the prefix for each scope that you define for the API.

4. Under Scopes defined by this API, select Add a scope.

5. To create a scope that defines read access to the API:

   1. For Scope name, enter tasks.read.
   2. For Admin consent display name, enter Read access to tasks API.
   3. For Admin consent description, enter Allows read access to the tasks API.

6. Select Add scope.

7. Select Add a scope, and then add a scope that defines write access to the API:

   1. For Scope name, enter tasks.write.
   2. For Admin consent display name, enter Write access to tasks API.
   3. For Admin consent description, enter Allows write access to the tasks API.

8. Select Add scope.

Step 2.3: Register the mobile app

To create the mobile app registration, do the following:

1. Sign in to the Azure portal.

2. Select App registrations, and then select New registration.

3. Under Name, enter a name for the application (for example, android-app1).

4. Under Supported account types, select Accounts in any identity provider or organizational directory (for authenticating users with user flows).

5. Under Redirect URI, select Public client/native (mobile & desktop) and then, in the URL box, enter one of the following URIs:

   • For the Kotlin sample: msauth://com.azuresamples.msalandroidkotlinapp/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D
   • For the Java sample: msauth://com.azuresamples.msalandroidapp/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D

6. Select Register.

7. After the app registration is completed, select Overview.

8. Record the Application (client) ID for later use, when you configure the mobile application.

   

Step 2.4: Grant the mobile app permissions for the web API

To grant your app (App ID: 1) permissions, follow these steps:

1. Select App registrations, and then select the app that you created (App ID: 1).

2. Under Manage, select API permissions.

3. Under Configured permissions, select Add a permission.

4. Select the My APIs tab.

5. Select the API (App ID: 2) to which the web application should be granted access. For example, enter my-api1.

6. Under Permission, expand tasks, and then select the scopes that you defined earlier (for example, tasks.read and tasks.write).

7. Select Add permissions.

8. Select Grant admin consent for <your tenant name>.

9. Select Yes.

10. Select Refresh, and then verify that Granted for ... appears under Status for both scopes.

11. From the Configured permissions list, select your scope, and then copy the scope full name.

    

Step 3: Get the Android mobile app sample

Do either of the following:

• Download either of these samples:

  • Kotlin
  • Java

  Extract the sample .zip file to your working folder.

• Clone the sample Android mobile application from GitHub.

  Kotlin

  git clone https://github.com/Azure-Samples/ms-identity-android-kotlin
  

  Java

  git clone https://github.com/Azure-Samples/ms-identity-android-java
  

Step 4: Configure the sample web API

This sample acquires an access token with the relevant scopes that the mobile app can use for a web API. To call a web API from code, do the following:

1. Use an existing web API, or create a new one. For more information, see Enable authentication in your own web API by using Azure AD B2C.
2. Change the sample code to call a web API.

Step 5: Configure the sample mobile app

Open the sample project with Android Studio or another code editor, and then open the /app/src/main/res/raw/auth_config_b2c.json file.

The auth_config_b2c.json configuration file contains information about your Azure AD B2C identity provider. The mobile app uses this information to establish a trust relationship with Azure AD B2C, sign users in and out, acquire tokens, and validate them.

Update the following app settings properties:

Key	Value
client_id	The mobile application ID from step 2.3.
redirect_uri	The mobile application redirect URI from step 2.3.
authorities	The authority is a URL that indicates a directory that the MSAL can request tokens from. Use the following format: https://<your-tenant-name>.b2clogin.com/<your-tenant-name>.onmicrosoft.com/<your-sign-in-sign-up-policy>. Replace <your-tenant-name> with your Azure AD B2C tenant name. Then, replace <your-sign-in-sign-up-policy> with the user flows or custom policy that you created in step 1.

Open the B2CConfiguration class, and update the following class members:

Key	Value
Policies	The list of user flows or custom policies that you created in step 1.
azureAdB2CHostName	The first part of your Azure AD B2C tenant name (for example, https://contoso.b2clogin.com).
tenantName	Your Azure AD B2C tenant full tenant name (for example, contoso.onmicrosoft.com).
scopes	The web API scopes that you created in step 2.4.

Step 6: Run and test the mobile app

1. Build and run the project.

2. At the top left, select the hamburger icon (also called the collapsed menu icon), as shown here:

   

3. On the left pane, select B2C Mode.

   

4. Select Run User Flow.

   

5. Sign up or sign in with your Azure AD B2C local or social account.

6. After successful authentication, you'll see your display name on the B2C mode pane.

   

Next steps

Learn how to:

• Enable authentication in your own Android app
• Configure authentication options in an Android app
• Enable authentication in your own web API