Auth0.Android

Auth0.Android のインストール、初期化、使用方法を学びます

Auth0.Android は、Android アプリでユーザーを認証し、Auth0 API にアクセスするために使用できるクライアントサイドのライブラリです。

GitHub の Auth0.Android リポジトリ をご覧ください。

要件

Android API バージョン 21 以降が必要です。

インストール

SDK をプロジェクトに追加します。このライブラリを使用すると、Auth0 の Authentication API と Management API にリクエストを送信できます。

Gradle に Auth0 を追加する

アプリの build.gradle の dependencies セクションに、以下を追加します。

dependencies {
  // Auth0 Android SDKを追加
  implementation 'com.auth0.android:auth0:4.0.0'
}

Android Studio で + 記号に lint の警告が出る場合や、固定バージョンを使いたい場合は、最新バージョンを Maven で確認してください。

Gradle でプロジェクトを同期

Android Studio の prompt を使って同期するか、コマンドラインから ./gradlew clean build を実行することを忘れないでください。

android セクションでは、Android と Kotlin の各プラグインで Java 8 バイトコードをターゲットにしてください。

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

権限

アプリケーションの AndroidManifest.xml ファイルを開き、次の権限を追加します。

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

Universal Login 向けの設定

まず、Auth0 Dashboard > アプリケーション に移動し、編集するアプリケーションの名前をクリックします。Allowed Callback URLs で、URL が次の形式になっていることを確認します。 https://YOUR_DOMAIN/android/{YOUR_APP_PACKAGE_NAME}/callback

次に、{YOUR_APP_PACKAGE_NAME} を実際のアプリケーションのパッケージ名に置き換えます。これは app/build.gradle ファイルの applicationId の値で確認できます。

続いて、app/build.gradle ファイルに、Auth0 Domain と Auth0 Scheme のプロパティに対応する Manifest Placeholders を追加します。ライブラリはこれを使って、コールバック URI を受け取る intent-filter を登録します。

Web Authentication 機能を使用する予定がなく、manifest placeholders も宣言しない場合は、Android アプリの manifest ファイルで activity を手動で再宣言して、マージ後の manifest ファイルから削除できます。これにより、manifest placeholders が不足しているという Gradle の警告を回避できます。

詳しくは、FAQ をご覧ください。

apply plugin: 'com.android.application'

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

        //---> 次の行を追加
        manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"]
        //<---
    }
    //...
}

単にハードコーディングするのではなく、@string/com_auth0_domain のような再利用可能なリソースとして定義しておくことをおすすめします。

Auth0を初期化する

Auth0のclient IDとドメイン値を使用して、新しいAuth0オブジェクトを作成します。このオブジェクトは、後でAuth0のエンドポイントとやり取りする際に使用します。

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

このオブジェクトは、こちらの使用例のように、Android コンテキストを使って初期化することもできます。

次のステップ

WebAuthProvider クラスを使用して、アプリケーションでユーザーのログインとログアウトを行う

ユーザーのパスワードをリセットする

ユーザーのパスワードリセットを開始するには、ユーザーのメールアドレスとデータベース接続名をパラメータとして指定して、resetPassword を呼び出します。

パスワードリセットのリクエストは、ネットワーク関連のエラーが発生した場合は失敗しますが、指定されたメールアドレスがデータベース内に存在しない場合でも失敗しません (セキュリティ上の理由によるものです) 。

詳しくはこちら

• Auth0.Android Login、Logout、ユーザープロファイル
• Auth0.Android 設定オプション
• Auth0.Android データベース認証
• Auth0.Android パスワードレス認証
• Auth0.Android: User Management