Skip Navigation

MSAL Android Sample Microsoft Graph API Sample


Services: active-directory platforms: Android author: danieldobalian level: 100 client: Android Mobile App service: Microsoft Graph

endpoint: AAD V2

Getting Started Library API Reference Support

The MSAL Android preview gives your app the ability to begin using the Microsoft Azure Cloud by supporting Microsoft Azure Active Directory and Microsoft Accounts in a converged experience using industry standard OAuth2 and OpenID Connect. This sample demonstrates all the normal lifecycles your application should experience, including:

  • Get a token for the Microsoft Graph
  • Refresh a token
  • Call the Microsoft Graph
  • Sign out the user

Scenario

This app is a multi-tenant app meaning it can be used by any Azure AD tenant or Microsoft Account. It demonstrates how a developer can build apps to connect with enterprise users and access their Azure + O365 data via the Microsoft Graph. During the auth flow, end users will be required to sign in and consent to the permissions of the application, and in some cases may require an admin to consent to the app. The majority of the logic in this sample shows how to auth an end user and make a basic call to the Microsoft Graph.

Example

// Initialize your app with MSAL
PublicClientApplication pApp = new PublicClientApplication(
                this.getApplicationContext(),
                CLIENT_ID);

// Perform authentication requests
pApp.acquireToken(getActivity(), SCOPES, getAuthInteractiveCallback());

// ...

// Get tokens to call APIs like the Microsoft Graph
authenticationResult.getAccessToken();

Optional: Register your App

The app comes pre-configured for testing. If you would like to register your own app, please follow the steps below.

You will need to have a native client application registered with Microsoft using the App Registration Portal.

To create an app,
1. Click the Add an app button inside the Converged Apps section.

  1. Name your app and select Create.

    • After the app is created, you'll land on your app management page.
  2. Click Add Platform, then select Native Application.

    • The Redirect URI produced is needed when making Auth requests. If you're using MSAL, it will be automatically constructed by the library.
  3. Hit the Save button.

Steps to Run

  1. Clone the code. git clone https://github.com/Azure-Samples/active-directory-android-native-v2
  2. Open Android Studio 2, and select open an existing Android Studio project. Find the cloned project and open it.

  3. Select Build > Clean Project.

  4. Select Run > Run 'app'. Make sure the emulator you're using has Chrome, if it doesn't follow these steps. In Android Studio, we recommend using the Pixel image with Android 24.

Important Info

  1. There's a more complete app that stores global state and has cleaner UI in the full-sample branch. Check it out!
  2. Redirect URI format: msal<YOUR_CLIENT_ID>://auth is strictly enforced by MSAL at the current time.
  3. Find any problems or have requests? Feel free to create an issue or post on Stackoverflow with tag azure-active-directory.

Feedback, Community Help, and Support

We use Stack Overflow with the community to provide support. We highly recommend you ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before.

If you find and bug or have a feature request, please raise the issue on GitHub Issues.

To provide a recommendation, visit our User Voice page.

Contribute

We enthusiastically welcome contributions and feedback. You can clone the repo and start contributing now. Read our Contribution Guide for more information.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Security Library

This library controls how users sign-in and access services. We recommend you always take the latest version of our library in your app when possible. We use semantic versioning so you can control the risk associated with updating your app. As an example, always downloading the latest minor version number (e.g. x.y.x) ensures you get the latest security and feature enhanements but our API surface remains the same. You can always see the latest version and release notes under the Releases tab of GitHub.

Security Reporting

If you find a security issue with our libraries or services please report it to secure@microsoft.com with as much detail as possible. Your submission may be eligible for a bounty through the Microsoft Bounty program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting this page and subscribing to Security Advisory Alerts.