Android User Profile

This tutorial will show you how to use Lock to get the user's profile data in your Android apps with Auth0.

Sample Project

Download this sample project configured with your Auth0 API Keys.

System Requirements
  • Android Studio 2.2
  • Android SDK 24
  • Emulator - Nexus 5X - Android 6.0
Show requirements

Before Starting

Be sure that you have completed the Basic Login and the Session Handling Quickstarts.

Request User Data

The first step is to instantiate the authentication API client. This will be used to request the user's profile data.

AuthenticationAPIClient client = new AuthenticationAPIClient(

It's suggested that you add both the Auth0DomainID and Auth0ClientID to the strings.xml file rather than hardcode them in the manifest.

Then, use your previously stored credentials (in this example, stored in the Application Singleton) to request the data.

                .start(new BaseCallback<UserProfile, AuthenticationException>() {
  public void onSuccess(UserProfile payload){

  public void onFailure(AuthenticationException error){

Access The Data Inside The UserProfile


At this point, you already have access to the UserProfile. You can use this data wherever you need it.

Some examples are:


Remember that you can't modify the UI inside the onSuccess() method, as it works in a second thread. To solve this, you can persist the data, create a task in the UI thread or create a handler to receive that information.


Besides the defaults, you can handle more information that is contained within any of the following map:


The userMetadata map contains fields related to the user profile that can be added from the client-side (e.g. when editing the profile). We're going to edit this one in this tutorial. You can access its fields as follows:

String country = payload.getUserMetadata().get("country").toString();
boolean active = payload.getUserMetadata().get("active");

The strings you use for subscripting the userMetadata dictionary, and the variable types you handle, are up to you.


The appMetadata map contains fields that are usually added via a rule, which is read-only for the native platform.


The extraInfo map contains any other extra information stored in Auth0. That information is read-only for the native platform.

For further information on metadata, see the full documentation.

Update the User Profile

You can only update the user metadata. In order to do so you must: Create a Map<String, Object> and add the new metadata:

Map<String, Object> userMetadata = new HashMap<>();
userMetadata.put("country", "USA");

And then with the UserApiClient, perform the update:

UsersAPIClient usersClient = new UsersAPIClient(mAuth0, App.getInstance().getUserCredentials().getIdToken());
usersClient.updateMetadata(mUserProfile.getId(), userMetadata).start(new BaseCallback<UserProfile, ManagementException>() {
  public void onSuccess(final UserProfile payload) {
    // As receive the updated profile here
    // You can react to this, and show the information to the user.

  public void onFailure(ManagementException error) {

Previous Tutorial
4. Session Handling
Use Auth0 for FREECreate free Account