Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.
;
};
export const sections = [{
id: "auth0を構成する",
title: "Auth0を構成する"
}, {
id: "auth0-android-sdkをインストールする",
title: "Auth0 Android SDKをインストールする"
}, {
id: "マニフェストのプレースホルダーを追加する",
title: "マニフェストのプレースホルダーを追加する"
}, {
id: "アプリケーションを構成する",
title: "アプリケーションを構成する"
}, {
id: "アプリケーションにログインを追加する",
title: "アプリケーションにログインを追加する"
}, {
id: "アプリケーションにログアウトを追加する",
title: "アプリケーションにログアウトを追加する"
}, {
id: "ユーザープロファイル情報を表示する",
title: "ユーザープロファイル情報を表示する"
}];
Auth0のサービスを利用するには、Auth0 Dashboadに設定済みのアプリケーションがある必要があります。Auth0アプリケーションは、プロジェクトに認証を構成する場所です。
### アプリケーションを構成する
対話型のセレクターを使ってAuth0アプリケーションを新規作成するか、統合したいプロジェクトを表す既存のアプリケーションを選択します。Auth0のすべてのアプリケーションには英数字からなる一意のクライアントIDが割り当てられており、アプリケーションのコードがSDKを通じてAuth0 APIを呼び出す際に使用されます。
このクイックスタートを使って構成されたすべての設定は、[Dashboard](https://manage.auth0.com/#/)のアプリケーションを自動更新します。今後、アプリケーションの管理もDashboardで行えます。
代わりに完了済みの構成を見てみたい場合は、サンプルアプリケーションをご覧ください。
### Callback URLを構成する
Callback URLとは、Auth0によって認証後のユーザーをダイレクトするアプリケーションURLです。この値を設定していない場合、ユーザーはログイン後にアプリケーションに戻りません。
サンプルプロジェクトに沿って進めている場合は、`demo://{yourDomain}/android/YOUR_APP_PACKAGE_NAME/callback`に設定してください。
### ログアウトURLを構成する
ログアウトURLとは、Auth0によってログアウト後のユーザーをリダイレクトするアプリケーションURLです。この値を設定していない場合、ユーザーはアプリケーションからログアウトできず、エラーを受け取ります。
サンプルプロジェクトに沿って進めている場合は、`demo://{yourDomain}/android/YOUR_APP_PACKAGE_NAME/callback`に設定してください。
[Auth0 Android](https://github.com/auth0/Auth0.Android) SDKをプロジェクトに追加します。ライブラリーはAuth0のAuthentication APIとManagement APIに要求を行います。
アプリの`build.gradle`依存関係セクションで、以下を追加します。
```
implementation 'com.auth0.android:auth0:2. '
```
AndroidとKotlinのプラグインのそれぞれに対して、Java 8+バイトコードをターゲットにするようにします。
SDKにはマニフェストのプレースホルダーが必要です。Auth0は内部でプレースホルダーを使用して、認証のCallback URLを捉える`intent-filter`を定義します。Auth0テナントのドメインとCallback URLスキームを設定する必要があります。
アクティビティーに特別な`intent-filter`を宣言する必要はありません。これは、マニフェストのプレースホルダーをAuth0**ドメイン** と**スキーム** の値で定義したため、ライブラリーがリダイレクトを処理します。
ここでは、`auth0Scheme`に`demo`の値を使用したため、カスタムURLスキームをログイン後にAuth0がリダイレクトするURLに使用することができます。[Androidアプリのリンク](/docs/ja-jp/applications/enable-android-app-links)を使用したい場合は、`https`を使用する方法もあります。この値の設定に関する詳細情報は、[Auth0.Android SDKのREADME](https://github.com/auth0/Auth0.Android#a-note-about-app-deep-linking)をお読みください。
SDKが正しく機能するためには、次のプロパティを`strings.xml`で設定しなければなりません：
* `com_auth0_domain`：Auth0テナントのドメインです。通常、Auth0 Dashboardにあるアプリケーションの［Settings（設定）］の［Domain（ドメイン）］フィールドで確認できます。[カスタムドメイン](/docs/ja-jp/custom-domains)を使用している場合は、その値を代わりに設定してください。
* `com_auth0_client_id`：このクイックスタートで前にセットアップしたAuth0アプリケーションのIDです。Auth0 Dashboardにあるアプリケーションの［Settings（設定）］の［Client ID（クライアントID）］フィールドで確認できます。
`AndroidManifest.xml`ファイルが`android.permissions.INTERNET`のアクセス許可を指定していることを確認します。
```html theme={null}
```
Android Studio内で**Sync Project with Gradle Files** を実行するか、コマンドラインから`./gradlew clean assembleDebug`を実行します。
Gradleの使用に関する詳細は、[Gradleの公式のドキュメンテーション](https://gradle.org/getting-started-android-build/)を確認してください。
アプリケーションに認証をセットアップするには、[ユニバーサルログイン](/docs/ja-jp/hosted-pages/login)が最も手軽な方法です。最良のエクスペリエンス、高い安全性、幅広い機能を活用するためにも、ユニバーサルログインの使用をお勧めします。
`onCreate`メソッドで、`Auth0`クラスの新しいインスタンスを作成し、ユーザー資格情報を保持します。
`loginWithBrowser`メソッドを作成し、`WebAuthProvider`クラスを使用して、[Auth0 Dashboard](https://manage.auth0.com/#/)のアプリケーションで有効にした接続で認証します。ここでは、初期設定の一部として`auth0Scheme`マニフェストのプレースホルダーで使用されたスキーム値を渡すことができます。
`WebAuthProvider#start`関数を呼び出した後、ブラウザーが起動し、ログインページが表示されます。ユーザーが認証を行うと、Callback URLが呼び出されます。Callback URLには、認証プロセスの最終結果が含まれています。
##### チェックポイント
loginWithBrowserを呼び出すアプリケーションにボタンを追加します。このボタンをクリックすると、AndroidアプリケーションによってAuth0ユニバーサルログインページにリダイレクトされ、ユーザー名とパスワードまたはソーシャルプロバイダーを使ってログインまたはサインアップできるようになったことを確認します。
完了したら、Auth0がアプリにリダイレクトで戻すことを確認します。
`WebAuthProvider`を使用して、認証時にブラウザーで設定されたクッキーを削除すると、ユーザーは次回の認証試行時に、資格情報を再入力するよう求められます。
`logout`メソッドをアプリに追加してユーザーのセッションを削除し、アプリからログアウトします。ここでは、初期設定の一部として`auth0Scheme`マニフェストのプレースホルダーで使用されたスキーム値を渡すことができます。
`WebAuthProvider`クラスを使用して、ログアウトを実装します。この呼び出しによってブラウザーが開き、ユーザーはログアウトエンドポイントに移動されます。ユーザーがログアウトをキャンセルする場合は、ユーザーを前のURLにリダイレクトすることを検討してください。
##### チェックポイント
logoutを呼び出し、ユーザーをアプリケーションからログアウトするアプリにボタンを追加します。このボタンをクリックすると、Androidアプリがユーザーをログアウトページにリダイレクトしてからもう一度リダイレクトで戻すこと、そして、アプリケーションにログインしていないことを確認します。
`AuthenticationAPIClient`クラスを使用して、[Auth0からユーザーのプロファイルを取得します](/docs/ja-jp/users/user-profiles#user-profile-management-api-access)。これには以下のものが必要です。
* ログインフェーズから返されるアクセストークン
* `WebAuthProvider.login`に`profile`スコープが含まれる必要がある
ユーザーのメールアドレスを取得する必要がある場合は、`email`スコープを指定する必要があります。
このクイックスタートで、上のログイン手順中にデフォルトで`openid profile email`スコープが設定されます。
以下に、ユーザーのプロファイルを取得して画面上に表示するために使用できる関数を示します。
##### チェックポイント
ログイン後にshowUserProfile関数を呼び出します。onSuccessコールバックがユーザーのプロファイル情報を返すことを確認します。
## 次のステップ
成功です！ここまで来れば、アプリケーションにログイン、ログアウト、ユーザープロファイル情報が備わっているはずです。
これでクイックスタートチュートリアルは終了ですが、機能はまだまだたくさんあります。Auth0でできることについて詳しくは、以下をご覧ください。
* [Auth0 Dashboard](https://manage.auth0.com/#) - Auth0のテナントやアプリケーションを構成して管理する方法について説明します
* [Auth0.Android SDK](https://github.com/auth0/Auth0.Android) - このチュートリアルで使用されているSDKをより詳しく説明します
* [Auth0 Marketplace](https://marketplace.auth0.com/) - Auth0の機能性を拡張できる各種の統合を見つけられます
```gradle build.gradle lines highlight={18} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
```kt MainActivity.kt lines highlight={6-38} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```gradle build.gradle lines highlight={10-12} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
```kt MainActivity.kt lines highlight={6-38} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
```gradle build.gradle lines highlight={18} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```kt MainActivity.kt lines highlight={6-38} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```kt MainActivity.kt lines highlight={6-38} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```gradle build.gradle lines highlight={18} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
```kt MainActivity.kt lines highlight={40-52} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```gradle build.gradle lines highlight={18} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
```kt MainActivity.kt lines highlight={54-70} theme={null}
import com.auth0.android.Auth0
import com.auth0.android.provider.WebAuthProvider
class MainActivity : AppCompatActivity() {
private lateinit var account: Auth0
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Set up the account object with the Auth0 application details
account = Auth0(
getString(R.string.com_auth0_client_id),
getString(R.string.com_auth0_domain),
)
}
private fun loginWithBrowser() {
// Setup the WebAuthProvider, using the custom scheme and scope.
WebAuthProvider.login(account)
.withScheme("demo")
.withScope("openid profile email")
// Launch the authentication passing the callback where the results will be received
.start(this, object : Callback {
// Called when there is an authentication failure
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
// Called when authentication completed successfully
override fun onSuccess(credentials: Credentials) {
// Get the access token from the credentials object.
// This can be used to call APIs
val accessToken = credentials.accessToken
}
})
}
private fun logout() {
WebAuthProvider.logout(account)
.withScheme("demo")
.start(this, object : Callback {
override fun onSuccess(payload: Void?) {
// The user has been logged out!
}
override fun onFailure(error: AuthenticationException) {
// Something went wrong!
}
})
}
private fun showUserProfile(accessToken: String) {
var client = AuthenticationAPIClient(account)
// With the access token, call `userInfo` and get the profile from Auth0.
client.userInfo(accessToken)
.start(object : Callback {
override fun onFailure(exception: AuthenticationException) {
// Something went wrong!
}
override fun onSuccess(profile: UserProfile) {
// We have the user's profile!
val email = profile.email
val name = profile.name
}
})
}
}
```
```gradle build.gradle lines highlight={18} theme={null}
apply plugin: 'com.android.application'
android {
defaultConfig {
applicationId "com.auth0.samples"
minSdkVersion 21
targetSdkVersion 30
// ...
// ---> Add the next line
manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "demo"]
// <---
}
}
dependencies {
// Add the Auth0 Android SDK
implementation 'com.auth0.android:auth0:2.+'
}
```
```xml strings.xml lines highlight={2-3} theme={null}
"{yourDomain}""{yourClientId}"
```
Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.