- Auth0 Mobile SDKとAuth0 Single-Page App SDK:フローを実装する最も簡単な方法です。難しくて手間がかかる作業のほとんどが処理されます。Mobile QuickstartsとSingle-Page App Quickstartsでこのプロセスについて説明しています。
- 認証API:独自のソリューションを構築したい場合は、このまま読み続けて、APIを直接呼び出す方法を学習してください。
/userinfo
エンドポイントや独自の保護されたAPIを呼び出すのに使用することができます。IDトークンの詳細については、「IDトークン」をお読みください。アクセストークンの詳細については、「アクセストークン」をお読みください。
前提条件
アプリをAuth0に登録する必要があります。詳細については、「ネイティブアプリケーションを登録する」または「シングルページWebアプリケーションを登録する」をお読みください。- アプリケーションタイプに応じて、[Native(ネイティブ)] または [Single-Page App(シングルページアプリ)] の [Application Type(アプリケーションタイプ)] を選択します。
YOUR_CALLBACK_URL
の [Allowed Callback URL(許可されているコールバックURL)] を追加します。コールバックURLの形式は、使用しているアプリケーションタイプとプラットフォームによって異なります。アプリケーションタイプの形式とプラットフォームの詳細については、「Mobile/Native Quickstarts」と「Single-Page App Quickstarts」を参照してください。- アプリケーションの [Grant Types(付与タイプ)] に [Authorization Code(認可コード)] が必ず含まれていることを確認してください。詳細については、「付与タイプを更新する」をお読みください。
コードベリファイアを作成する
code_verifier
を作成します。これは、トークンを要求するために最終的にAuth0に送信される、暗号的にランダムなBase64でエンコードされたキーです。
code_verifier
を作成するアルゴリズムの詳細については、 Proof Key for Code Exchange仕様の「4.1 Client Creates a Code Verifier(クライアントがコード検証を作成)」セクションをお読みください。
Javascriptのサンプル
Javaのサンプル
Androidのサンプル
Swift 5のサンプル
Objective-Cのサンプル
コードチャレンジを作成する
authorization_code
を要求するためにAuth0に送信されるcode_verifier
からcode_challenge
を生成します。
code_challenge
がcode_verifier
からどのように派生するかの詳細については、OAuth Proof Key for Code Exchange仕様の「4.2 Client Creates the Code Challenge(クライアントがコードチャレンジを作成)」セクションをお読みください。
Javascriptのサンプル
Javaのサンプル
Swift 5のサンプル
Objective-Cのサンプル
ユーザーを認可する
ユーザーの認可を要求すると、authorization_code
でアプリにリダイレクトされます。
code_verifier
とcode_challenge
を作成したら、ユーザーの認可を取得する必要があります。技術的には、これが認可フローの始まりとなります。この手順には以下のようなプロセスが含まれます:
* ユーザーを認証する。
* 認証を行うために、ユーザーをIDプロバイダーへリダイレクトする。
* アクティブなシングルサインオン(SSO)セッションを確認する。
* 以前に同意を得ていない場合は、要求された権限レベルについてユーザーの同意を得る。
ユーザーを認可するために、アプリは前のステップで生成したcode_challenge
とcode_challenge
の生成に使用したメソッドを含め、ユーザーを認可URLに送信する必要があります。
認可URLの例
パラメーター
パラメーター名 | 説明 |
---|---|
response_type | Auth0が返す資格情報の種類を示します(code またはtoken )このフローでは、値はcode でなければなりません。 |
code_challenge | code_verifier から生成されたチャレンジ。 |
code_challenge_method | チャレンジを生成するために使用されるメソッド(例、S256)。PKCE仕様はS256 とplain の2つのメソッドを定義します。S256 はこの例で使用されておりAuth0がサポートしている唯一のものであるため、plain は推奨されていません。 |
client_id | アプリケーションのクライアントID。これは、アプリケーション設定で見つけることができます)。 |
redirect_uri | 認可がユーザーにより付与された後にAuth0がブラウザをリダイレクトするURL。認可コードは、code URLパラメーターで利用できます。アプリケーション設定で有効なコールバックURLとしてこのURLを指定する必要があります。 警告: OAuth 2.0の仕様に従って、Auth0はハッシュの後、すべてを削除し、フラグメントを受け付けません。 |
scope | 返したいクレーム(またはユーザー属性)を決定する、認可を要求したいスコープを指定します。スペースで区切る必要があります。応答でIDトークンを取るには、少なくともopenid のスコープを指定する必要があります。ユーザーのフルプロファイルを返したい場合は、openid profile を要求できます。email などのユーザーに関する標準OpenID Connect(OIDC)スコープまたは名前空間形式に従ったカスタムクレームを要求できます。offline_access を含めてを取得できます(Allow Offline Access(オフラインアクセスの許可)フィールドがアプリケーション設定で有効になっていることを確認してください)。 |
state | (推奨)Auth0がリダイレクトしてアプリケーションに戻る際に含まれ、アプリが初期要求に追加する不透明な任意の英数字の文字列。クロスサイトリクエストフォージェリ(CSRF)攻撃を防止するためにこの値を使用する方法については、状態パラメーターを使ってCSRF攻撃を軽減するをご覧ください。 |
connection | (任意)特定の接続でユーザーにサインインを強制します。たとえば、github の値を渡して、GitHubアカウントでログインするようにユーザーを直接GitHubに送信します。指定しなかった場合、ユーザーには、構成された接続すべてが表示されたAuth0 Lock画面が表示されます。アプリケーションのConnections(接続) タブで構成された接続のリストを確認できます。 |
organization | (任意)ユーザーを認証する時に使用する組織のID。提供されない場合、アプリケーションはDisplay Organization Prompt(組織のプロンプトを表示) に設定され、ユーザーは、認証時に組織名を入力できます。 |
invitation | (任意)組織の招待のチケットID。Organizationにメンバーを招待する場合、ユーザーが招待を受け入れたとき、アプリケーションは、invitation およびorganization のキー/値ペアを転送することで、招待の受け入れを処理する必要があります。 |
Response (レスポンス)
すべてが成功すると、HTTP 302
応答を受け取ります。認可コードはURLの末尾に含まれます:
トークンを要求する
authorization_code
とcode_verifier
をトークンと交換します。
取得した認可コードは、トークンと交換する必要があります。前の手順で抽出した認可コード(code
)を使用して、code_verifier
とともに送信するトークンURLにPOST
する必要があります。
トークンURLへのPOSTの例
パラメーター
パラメーター | 説明 |
---|---|
grant_type | これをauthorization_code に設定します。 |
code_verifier | 暗号的にランダムなキーです。このチュートリアルの最初の手順で生成しました。 |
code | このチュートリアルの前の手順で取得したauthorization_code です。 |
client_id | アプリケーションのクライアントIDです。この値は[Application Settings(アプリケーションの設定)]にあります。 |
redirect_uri | アプリケーションの設定で指定されている有効なコールバックURLです。このチュートリアルの前の手順で認可URLに渡されたredirect_uri と完全に一致しなければなりません。これは、URLエンコードする必要があります。 |
Response (レスポンス)
すべてが成功すると、access_token
、refresh_token
、id_token
、およびtoken_type
の値を含むペイロードとともに、HTTP 200の応答を受信します。
トークンは、検証してから保存します。操作方法については、「IDトークンの検証」および「アクセストークンを検証する」を参照してください。
refresh_token
は、offline_access
スコープを含め、DashboardでAPIの [Allow Offline Access(オフラインアクセスの許可)] を有効にした場合にのみ、応答内に表示されます。
リフレッシュトークンは、ユーザーが実質的に永久に認証された状態を維持できるようにするため、安全に保管しなければなりません。
ユースケース
基本的な認証要求
この例では、手順1でユーザーを認可する際に行う最も基本的な要求について説明します。Auth0のログイン画面を表示して、構成されている接続でユーザーがサインインできるようにします。ユーザーの名前とプロファイルの写真を要求する
通常のユーザー認証に加えて、この例では名前や写真など、追加のユーザー詳細情報を要求する方法について説明します。 ユーザーの名前や写真を要求するには、ユーザーを認可する際に、適切なスコープを追加する必要があります。GitHubでのユーザーログインを要求する
通常のユーザー認証に加えて、この例では、ユーザーをGitHubなどのソーシャルIDプロバイダーへ直接送る方法について説明します。この例を利用するには、[Auth0 Dashboard] > [Authentication(認証)] > [Social(ソーシャル)]に移動して、適切な接続を構成する必要があります。[Settings(設定)] タブから接続名を取得します。 ユーザーをGitHubのログイン画面へ直接送るには、connection
パラメーターを渡して、ユーザー認可時にその値を接続名(この場合はgithub
)に設定します。
sub
クレームが含まれます。IDトークンをデコードする際には、以下のようになります。