An Android application with Azure AD B2C using OAuth
[!NOTE] Use our newer Android AppAuth sample.
This sample is intended to demonstrate Azure AD B2C's compatibility with OAuth 3rd party libraries, however it has two major drawbacks compared to the newer AppAuth sample:
- This sample will not work for Google sign-in given that it uses embedded web-views which Google announced that they will end support for on April 20, 2017. AppAuth uses system web-views which will continue to work with Google sign-ins.
- The use of OAuth for sign-in requires a you to stand up a token validation service (included in the sample) which is not required when using OpenID Connect libraries such as AppAuth.
This sample demonstrates how to use Azure AD B2C with a prominent 3rd party Android OAuth2.0 library android-oauth-client. There's 3 parts of this sample you'll have to setup to get this running: do some configurations in our Azure portal and define your experience, configure/run the Android app, and finally configure/run the Node.js Web API.
Steps to Run
To use Azure AD B2C, you'll first need to create an Azure AD B2C tenant, register your application, and create some sign in and sign up experiences.
To create an Azure AD B2C tenant, checkout these steps.
To register your app, checkout these steps. Make sure the "Native Client" switch is turned to "Yes".
You can now define your custom sign in and sign up experience. In Azure AD B2C, you define the experience your end users will encounter by creating policies. For this sample, you'll want to create a single combined Sign In/Sign up policy.
Clone the code.
git clone https://github.com/Azure-Samples/active-directory-b2c-android-native-nodejs-webapi.git
Setting up the Android App
In Android Studio, open an existing project and open the
android-oauth-client. You will likely get a few errors and need to install some additional tools in Android Studio. Follow the prompts and let Android Studio update the local data.
/samples/java/.../azureb2c/Azureb2cConstants.java, replace the following fields:
TENANT_IDwith the name of your Azure AD B2C tenant.
CLIENT_IDwhich can be found in the Azure Portal B2C under the label Application ID.
POLICY_NAMEwith the name of the sign in/sign up policy.
Go ahead and try the app. You'll be able to see your custom experience, sign up for an account, and sign in to an existing account. The app will immediately crash after you sign in unless you complete the Node.JS steps! The core oAuth2.0 code is located in
[!NOTE] This sample uses the Android embedded meaning tokens are stored in both persistent storage and in session cookies. When the sample performs a logout, it will remove all session cookies as Android doesn't allow specific session cookies to be removed.
Setting up the Node.js Web API
You should've already cloned the app before, go ahead and open the
token-validator-service-nodejs/index.jswith any text editor. Make sure you've installed Node.
Replace the following fields:
tenantIDwith the name of your Azure AD B2C tenant.
clientIDwith the same Client/App ID as you used in the Android code.
policyNamewith the same name as before.
Install the node dependencies:
npm install && npm update
Run the Web API!
[!NOTE] This sample uses a 3rd party library (see Note below) that does not refresh Access Tokens. We have added the logic to check if the Access Token is expired, and indicated with a comment where refresh logic should be applied.
Now run both the Android app and Node web API at the same time. You'll see after you sign in, a request gets sent to the web API to validate the access token, and all the validated claims (fields inside the token) are sent back. Finally, all the claims are dumped into the Android UI. Congrats!
Customize your user experience further by supporting more identity providers. Checkout the docs belows to learn how to add additional providers:
Questions & Issues
Please file any questions or problems with the sample as a GitHub issue. You can also post on Stackoverflow with the tag
azure-ad-b2c. For OAuth2.0 library issues, please see note below.
This sample was built and tested with the Android Virtual Device Manager on versions 22-24 using Android Studio 2.1.2.
[!NOTE] Microsoft has tested the android-oauth-client library in basic Azure AD B2C scenarios and confirmed that it works with our service and thus considers it Microsoft Compatible. Microsoft does not provide fixes for this library and has not done a full review of the library. Issues and feature requests should be directed to the library's open source project linked below. Also, this library utilizes embedded web-views rather than the system browser. Google has announced that on April 20, 2017 they will no longer support Google Account sign in with embedded web-views at which point those wishing to support Google accounts will need to update libraries.
android-oauth-client- This sample was adapted from this open-source oAuth client library.