Auth0.Android

Découvrez comment installer, initialiser et utiliser Auth0.Android

Auth0.Android est une bibliothèque côté client que vous pouvez utiliser avec votre application Android pour authentifier les utilisateurs et accéder aux API Auth0.

Consultez le dépôt Auth0.Android sur GitHub.

Exigences

Android API version 21 ou plus récente est requise.

Installation

Ajoutez le SDK à votre projet. La bibliothèque effectuera des requêtes aux API d’authentification et de gestion d’Auth0.

Ajouter Auth0 à Gradle

Dans la section dependencies du fichier build.gradle de votre application, ajoutez ce qui suit :

dependencies {
  // Ajouter le SDK Android Auth0
  implementation 'com.auth0.android:auth0:4.0.0'
}

Si Android Studio signale une erreur concernant le signe +, ou si vous souhaitez utiliser une version précise, consultez la plus récente dans Maven.

Synchroniser le projet avec Gradle

N’oubliez pas de synchroniser à l’aide de l’invite d’Android Studio ou d’exécuter ./gradlew clean build depuis la ligne de commande.

Dans la section android, ciblez le bytecode Java 8 pour les plugins Android et Kotlin, respectivement.

android {
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
  kotlinOptions {
    jvmTarget = '1.8'
  }
}

Autorisations

Ouvrez le fichier AndroidManifest.xml de votre application et ajoutez l’autorisation suivante.

<uses-permission android:name="android.permission.INTERNET" />

Configurer pour Universal Login

D’abord, accédez à Dashboard > Applications et cliquez sur le nom de l’application que vous souhaitez modifier. Dans Allowed Callback URLs, assurez-vous que votre URL respecte ce format : https://YOUR_DOMAIN/android/{YOUR_APP_PACKAGE_NAME}/callback

Ensuite, remplacez {YOUR_APP_PACKAGE_NAME} par le véritable nom de package de votre application. Vous le trouverez dans votre fichier app/build.gradle, à la valeur applicationId.

Puis, dans votre fichier app/build.gradle, ajoutez les espaces réservés du manifeste pour les propriétés Auth0 Domain et Auth0 Scheme, que la bibliothèque utilisera pour enregistrer un intent-filter qui capture l’URI de rappel.

Si vous ne prévoyez pas utiliser la fonctionnalité Web Authentication ni déclarer les espaces réservés du manifeste, vous pouvez redéclarer manuellement l’activité dans le fichier manifeste de votre application Android afin de la retirer du fichier manifeste fusionné. Cela empêchera Gradle de signaler l’absence des espaces réservés du manifeste.

Veuillez consulter la FAQ pour en savoir plus.

apply plugin: 'com.android.application'

android {
    compileSdkVersion 30
    defaultConfig {
        applicationId "com.auth0.samples"
        minSdkVersion 21
        targetSdkVersion 30
        //...

        //---> Ajouter la ligne suivante
        manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"]
        //<---
    }
    //...
}

C’est une bonne pratique de définir des ressources réutilisables comme @string/com_auth0_domain au lieu de les coder en dur.

Initialiser Auth0

Créez un nouvel objet Auth0 à l’aide de votre ID client Auth0 et de la valeur du domaine. Les objets s’en serviront plus tard pour interagir avec les points de terminaison d’Auth0.

val auth0 = Auth0("{yourClientId}", "YOUR_DOMAIN")

Vous pouvez aussi initialiser cet objet à l’aide d’un Context Android, comme dans cet exemple d’utilisation.

Prochaines étapes

Connectez les utilisateurs à votre application et déconnectez-les à l’aide de la classe WebAuthProvider.

Réinitialiser le mot de passe de l’utilisateur

Pour lancer la réinitialisation du mot de passe d’un utilisateur, appelez resetPassword en lui passant l’adresse courriel de l’utilisateur et le nom de la connexion de base de données en paramètres.

Les requêtes de réinitialisation du mot de passe échouent en cas d’erreur liée au réseau, mais pas si l’adresse courriel indiquée n’existe pas dans la base de données (pour des raisons de sécurité).

En savoir plus

• Auth0.Android Connexion, déconnexion et profils utilisateur
• Auth0.Android Options de configuration
• Auth0.Android Authentification par base de données
• Auth0.Android Authentification sans mot de passe
• Auth0.Android : Gestion des utilisateurs