Implicit grantを設定する



Alexa Skills Kitは、カスタムスキルでのアカウントリンクでImplicit grantをサポートしています。このGrant種別は、スマートホームスキルなどその他の種類のスキルには使用できません。

Implicit grantフローの概要

ユーザーはスキルを有効にする時点で、またはAlexaアプリのアカウントリンクカードから、アカウントリンクプロセスを開始できます。ユーザーのアカウントリンク操作の詳細については、カスタムスキルのアカウントリンクを参照してください。

  1. Alexaアプリでスキルを有効にする、またはアカウントリンクカードのリンクをタップすると、プロセスが開始されます。

  2. Alexaアプリでは、アカウントリンクを設定する際に指定した認証画面のURIを使用してアプリにログインページを表示します。このログインページでは認可サーバーを使用してユーザーの認証を行います。

    Alexaアプリが指定した認証画面のURIを呼び出すと、このURIにはクエリー文字列のパラメーターとしてstateclient_idresponse_typescoperedirect_uriが含まれます。

  3. ユーザーは認可サーバーの認証情報を使ってログインします。
  4. ユーザーが認証されると、認可サーバーはユーザーを一意に識別するアクセストークンaccess_token)を生成します。
  5. 認可サーバーによりユーザーは指定されたredirect_uriにリダイレクトされます。その際、URLフラグメントでstateaccess_tokentoken_typeが渡されます。
  6. AlexaサービスはAlexaユーザーのaccess_tokenを保存します。

    ユーザーのAlexaアカウントはサービスのアカウントにリンクされ、スキルが使用できるようになりました。

  7. ユーザーがスキルにリクエストを行うとき、スキルに送信されるすべてのリクエストIntentRequestなど)にアクセストークン(access_token)が含まれるようになります。スキルはこのトークンを使ってリソースサーバーから必要な情報を取得します。

以下の図は、ユーザーがアカウントをリンクしてAlexaが認可サーバーからアクセストークンを取得するときの最初のセットアップを表しています。

Implicit grantフロー
Implicit grantフロー

この図では、ユーザーがスキルに対してリクエストを行い、スキルがアクセストークンを使ってリソースサーバーから情報を取得するフローを表しています。

スキルとの対話のシーケンス
スキルとの対話のシーケンス

Implicit grantの設定手順

  1. Implicit grantを使用したアカウントリンクの要件を満たす認可サーバーがあることを確認します。

    • 認可サーバーは必須パラメーターを受け入れ、ユーザーを認証し、access_tokenを生成してAmazonが提供するredirect_uriにユーザーをリダイレクトできる必要があります。

    詳細については、認証画面のURIを参照してください。

  2. 開発者ポータルでImplicit grant用にスキルを設定します。詳細については、開発者ポータルでアカウントリンクを設定するを参照してください。

Implicit grantを設定したら、次の手順に進み、スキルコードにアクセストークンを検証して使用する処理を追加します。関連トピック:

認証画面のURI

ユーザーがアカウントリンクのプロセスを開始すると、Alexaアプリに認可サーバーのログインページが表示されます。認可サーバーは、ユーザーの認証情報を検証してアクセストークンを返す必要があります。

開発者ポータルのビルド > アカウントリンクページにこのログインページのURLを指定します。ログインページのURLは、認証画面のURIフィールドに入力します。

サードパーティOAuthプロバイダーの認証画面のURI

サードパーティOAuthプロバイダーを使用する場合、そのプロバイダーのドキュメントを確認してアカウントリンクの設定に必要な認証画面のURIを決めてください。認可リクエストのURIを検索します。

認証画面のURIに渡されるパラメーター

認証画面のURIを呼び出す場合、AlexaアプリではURLのクエリー文字列に以下のパラメーターを含みます。

パラメーター 説明

client_id

スキルのIDです。このIDを使って、アカウントリンクを使うよう設定した他のスキルと区別するなど、スキル固有の機能を提供できます。client_idは、スキルのアカウントリンクを設定する際に定義します。

redirect_uri

サービスが認証したユーザーをリダイレクトする、Amazon固有のリダイレクト先のエンドポイント(リダイレクト先のURL)です。このパラメーターで想定される値は、開発者コンソールでスキルのアカウントリンクを設定する際にも表示されます。

response_type

他のサービスによってユーザーが認証された後に返される応答の種類を表します。Implicit grantでは常にtokenです。

scope

Alexaユーザーが必要とするアクセスを表すスコープのリスト(任意)です。これらのスコープは、スキルのアカウントリンクを設定する際に定義します。

  • サービスはアクセストークンを生成するときにこの情報を使用します。たとえば、リソースサーバーの基本のプロファイル情報へのアクセスは許可するが支払い情報へのアクセスは認めないトークンを、サービスが作成する場合などです。
  • スコープは複数使用できます。リストは、URLエンコードされたスペースで区切ります。
  • ログインページでは、ユーザーにアカウントリンクによってどのようなアクセスが付与されるかを伝える必要があります。たとえば、ログインページには「アカウントリンクを行うと、タクシー予約スキルがあなたに代わってタクシーの配車を依頼し、料金をあなたの口座に請求できるようになります。」などのテキストを表示できます。 スマートホームスキルの場合、このページには「アカウントリンクを行うと、マイライトスキルでマイライトハブに接続された照明を制御できるようになります。」などと表示できます。

state

アカウントリンクを使用してユーザーをトラッキングするために、Alexaサービスが内部的に使用する値です。

認証画面のURIは、リダイレクト先のURLが呼び出された場合にこの値を変更せずに戻す必要があります。

たとえば、ページの認証画面のURIがhttps://www.carfu.com/loginの場合、Alexaアプリによって呼び出されるURLは以下のようになります。

https://www.carfu.com/login?state=abc&client_id=unique-id&scope=order_car%20basic_profile&response_type=token&redirect_uri=https%3A//pitangui.amazon.com/spa/skill/account-linking-status.html%3FvendorId%M2AAAAAAAAAAAA

ユーザーの言語でのログインページの作成

Alexaアプリは、ユーザーが使用するブラウザがサポートされている言語のいずれかで設定されている場合、ブラウザの言語設定を使用してアプリを表示しようとします。これ以外の言語の場合、アプリはデフォルトでen-usになります。

ユーザーエクスペリエンスに一貫性を持たせるには、ログインページもAlexaアプリと同じ言語で表示するようにしてください。言語の情報を取得するには、まずAccept-Languageヘッダーを確認します。Alexaアプリは認証画面のURIを呼び出すとき、このヘッダーを設定しようとします。

ヘッダーが設定されていない場合、navigator.languageまたはnavigator.browserLanguageを確認してユーザーのブラウザで定義されている言語を使用できます。Navigator言語プロパティを参照してください。

ユーザーのブラウザ設定は、ユーザーのAlexa搭載デバイスで定義されている言語とは関係ありません。たとえばユーザーは、デバイスで日本語を使うよう設定し、ブラウザを英語(英国)で使うよう設定することができます。この場合、Alexaアプリは日本語で表示され、Accept-Languageヘッダーは英語(en-gb)に設定されます。

ユーザーにとって使いやすいログインエクスペリエンスの提供

ユーザーがアカウントリンクプロセスを開始すると、Alexaアプリは指定したログインページを表示します。すでにサービスを使っているユーザーだけでなく、Alexaからサービスを見つけ、サービスのアカウントを作成してくれるかもしれないユーザーにとっても、使いやすいエクスペリエンスを提供するようにしてください。

以下に、ログインページのベストプラクティスをいくつか紹介します。

  • ログインページのユーザー名やメールアドレスのフィールドでは、オートコレクトや自動で頭文字を大文字にするオプションはオフにし、入力エラーが少なくなるようにします。
  • フォームのフィールド検証を使い、末尾のスペースや大文字小文字の誤りといったよくあるエラーを検知できるようにします。郵便番号や電話番号などのフィールドでは、スキルを利用できる地域ごとに適切な検証処理を適用するようにします。
  • ページでは、入力可能なユーザー認証情報について指示します。たとえば、ユーザーがAmazonアカウントではなくサービスの認証情報でログインする必要がある点を明確に説明します。サードパーティの認証サーバーを使用する場合は、そのサーバーの認証情報でログインする必要がある点をはっきりと伝えます。
  • サービスのウェブサイトやモバイルアプリでFacebook、Amazon、Googleなど複数のサインインメカニズムをサポートしている場合、ログインページでも同じメカニズムをサポートするようにします。サポートしない場合、サービスを使用するユーザーがアカウントをリンクできません。
  • サービスのウェブサイトやモバイルアプリで新しいアカウントの作成をサポートし、このフローのサポートとテストも行えるようにします。ユーザーは新しいアカウントの作成とリンクをシームレスに行う必要があるため、ユーザーがAlexaを使用して初めてサービスを見つけた場合も考慮します。
  • アカウント名やパスワードを忘れてしまったユーザーのために、アカウントの復旧オプションをサポートします。

以上すべてのシナリオを使ってアカウントリンクをテストし、ユーザーに使いやすいページになっているかどうかを確認します。ユーザーがログインできない場合に表示されるエラーメッセージが、問題を明確に伝えていることを確認します。

Alexaスキルにアカウントリンクを追加する10のヒント(英語)も参照してください。

認証画面のURI要件

認証画面のURIは、以下の要件を満たす必要があります。

  • HTTPS経由で提供される必要があります。
  • Alexaアプリで表示されるため、モバイルでも見やすいログインページにする必要があります。
  • このページをポップアップウィンドウで開いたり、JavaScriptのアラートやメッセージボックスを起動することはできません。ユーザーにエラーが発生した場合(ユーザーが誤ったユーザー名やメールアドレス、パスワードを入力した場合など)、エラーは同じログインページにインラインで表示される必要があります。
  • ユーザーの認証情報を受け取り、認可サーバーを使用してユーザーを認証する必要があります。
  • リソースサーバーでユーザーを一意に識別するアクセストークンを生成する必要があります。
  • クエリ文字列で渡されるstate値をトラッキングする必要があります。
  • ユーザー認証後、ページはAmazonが提供するリダイレクト先のエンドポイント(リダイレクト先のURL)にユーザーをリダイレクトする必要があります。
    • 使用するURLは、redirect_uriパラメーターとして認可リクエストに含まれます。
    • スキルのアカウントリンクを設定する際、開発者コンソールにはその他のURLも表示されるため、ログインページがredirect_uriパラメーターとして受け取る可能性のある値を確認できます。
    • URLフラグメントにstateaccess_tokentoken_typeを含みます。token_typeBearerにする必要があります。
  • OAuth 2.0を実装していない場合、OAuth 2.0プロバイダーとしてLogin with Amazon(LWA)を使用するか、Amazon認定の認証局によって署名された証明書を持つプロバイダーを使用することができます。このリストに記載されていても、https://letsencrypt.org/を使用することはできませんのでご注意ください。

たとえば、Amazonが提供するリダイレクト先のURLが以下だったとします。

https://pitangui.amazon.com/spa/skill/account-linking-status.html?vendorId=M2AAAAAAAAAAAA

ユーザーの認証画面のURIは、ユーザーを以下にリダイレクトします。

https://pitangui.amazon.com/spa/skill/account-linking-status.html?vendorId=M2AAAAAAAAAAAA#state=xyz&access_token=2YotnFZFEjr1zCsicMWpAA&token_type=Bearer

パラメーターは、URLのハッシュタグ(#)以降に指定されるURLフラグメントで渡されます。

アクセストークン

認可サーバーはユーザーを一意に識別するアクセストークンを提供する必要があります。スキルはこのトークンを使ってリソースサーバーのユーザーに関する情報にアクセスできます。

このトークンはユーザーの認証後にリダイレクト先のURLに含まれます。

Implicit grantでは更新トークンがサポートされないため、トークンの有効期限が切れた場合、ユーザーは再度アカウントリンクを行う必要があるので、ユーザーエクスペリエンスが低くなります。期限付きのトークンを使用する場合(推奨)、代わりにAuthorization code grantを使ってください。

アクセストークンを生成する場合、リソースサーバー固有のトークンを提供します。セキュリティを確保するため、トークンはユーザーを識別でき、推測できない値にしてください。

アカウントリンクの設定

開発者コンソールのビルド>アカウントリンクでアカウントリンクを有効にします。また、ASK CLIまたはスキル管理APIを使ってアカウントリンクを設定することもできます。

以下の表は、アカウントリンク設定で入力の必要なフィールドです。サードパーティOAuthプロバイダーを使用する場合、そのプロバイダーのドキュメントを確認してフィールドに入力する値を判断してください。

フィールド 説明

ユーザーがアカウントや既存アカウントへのリンクを作成することを許可しますか?

カスタムスキルでアカウントリンクを有効にする場合に選択します。 このオプションはスマートホームスキルとビデオスキルでは自動で選択されます。

ユーザーがアカウントリンクなしでスキルを有効にすることを許可してください

ユーザーがスキルを有効にする際にアカウントリンクフローを行わない場合は、これを選択します。カスタムスキルでのみ使用できます。スキルが、アカウントを必要とする機能にだけでなく、アカウントリンクが不要な便利な機能がある場合に使用します。ユーザーがアカウントをリンクせずにスキルを有効にするを参照してください。

このオプションはデフォルトではオンです。

Authorization Grant種別を選択

アクセストークン取得に使用するOAuth 2.0のAuthorization Grantです。Implicit Grantを選択します。

認証画面のURI

ユーザーがサービスへのログインに使用できるページのURIです。ユーザーがアカウントリンクプロセスを開始すると、Alexaアプリはこのページを表示します。詳細と要件については認証画面のURIを参照してください。

サードパーティのOAuthプロバイダーを使用している場合、認可リクエスト用に提供されているURIをご確認ください。たとえばLogin with Amazonの場合、認証画面のURIはhttps://www.amazon.com/ap/oaです。

ユーザーのクライアントID

認証をリクエストするユーザーを識別する一意の文字列です。この値は、client_idパラメーターとして認証画面のURIに渡されます。

サードパーティOAuthプロバイダーを使用している場合、プロバイダーが想定しているクライアントIDを確認してください。たとえばLogin with Amazonの場合、このIDはLogin with Amazonのセキュリティプロファイルを作成するときに作成されます。

Scope

他のサービスの権限のリスト(任意)です。リソースサーバーがさまざまなアクセススコープをサポートする場合、それらのスコープをここで指定します。最大15個まで指定できます。

ここで指定するすべてのスコープは、Alexaアプリが認証画面のURIを呼び出す際のscopeパラメーターに含まれます(URLエンコードされたスペースで区切る)。

サードパーティのOAuthプロバイダーを使用している場合、プロバイダーがサポートするスコープのセットから指定してください。たとえばLogin with Amazonの場合、profileprofile:user_idpostal_codeがサポートされます。

ドメインリスト

認証画面のURIがデータを取得するドメインのリスト(任意)です。ログインページが他のドメインからコンテンツを取得する場合は、そのドメインをこのリストに指定します。

認証画面のURI外のドメインの場合にのみ必須です。たとえば、認証画面のURIがhttps://www.carfu.com/loginだとします。ページがwww.carfu.com外のドメインから画像などのコンテンツを取得する場合、これらをドメインリストに追加する必要があります。最大30個まで指定できます。

Alexaのリダイレクト先のURL

ユーザー認証後にユーザーをリダイレクトするAmazon提供のリダイレクト先のエンドポイントが表示されます。リクエストに使用する値は、認証画面のURIに含まれるredirect_uriパラメーターとしてログインページに渡されます。リダイレクト先のエンドポイントを参照してください。

Alexaのリダイレクト先のURL

Alexaが使用するリダイレクト先のエンドポイントは、開発者コンソールのビルド>アカウントリンクページのAlexaのリダイレクト先のURLフィールドに表示されます。このエンドポイントはユーザー認証後にログインページがユーザーをリダイレクトする必要のあるURLです。

Alexaのリダイレクト先のURLには、複数のURIが表示されます。Alexaアプリは認証画面のURIに、ユーザーがデバイスを登録した場所に応じて使用する値を渡します。URIは、redirect_uriパラメーターとして認証画面のURIに渡されます。

リダイレクト先のエンドポイントを認可サーバーのホワイトリストに登録する

リダイレクト先のエンドポイントは通常、特に認可サーバーを所有していない場合でも認証画面のURIから呼び出すことができるように認可サーバーのホワイトリストに登録する必要があります。スキルが複数の地域で機能するよう、ユーザーのリダイレクト先のURLに表示されるすべてのURIをホワイトリストに登録してください。

ホワイトリストへの登録方法は、使用する認可サーバーによって異なります。たとえばLogin with Amazonでは、セキュリティを設定して利用可能なリダイレクト先URLリダイレクトURLフィールドに指定する必要があります。

これらの要件については、OAuthプロバイダーのドキュメントを参照してください。

たとえば、Implicit grantのredirect_uriパラメーターに渡される値はこのようになります。

https://pitangui.amazon.com/spa/skill/account-linking-status.html?vendorId=M2AAAAAAAAAAAA

認証画面のURIの要件で述べたとおり、認証画面のURIはユーザーをredirect_uriにリダイレクトし、URLフラグメントにstateaccess_tokentoken_typeを含めます。例:

https://pitangui.amazon.com/spa/skill/account-linking-status.html?vendorId=M2AAAAAAAAAAAA#state=xyz&access_token=2YotnFZFEjr1zCsicMWpAA&token_type=Bearer

アカウントリンクフローのテスト

アカウントリンクの設定を完了すると、アカウントリンクフローをテストできます。Alexaアプリでスキルを有効にし、アカウントリンクプロセスを開始します。サービスにログインしてAlexaアプリに戻ることを確認します。

アカウントリンクの実装を終了するには、受信するリクエストにアクセストークンがあるかどうかを確認して適切なアクションを実行するよう、スキルコードを更新する必要があります。詳細については、以下を参照してください。

CLIまたはスキル管理APIを使ったアカウントリンクの設定:

OAuthのリソース:

その他のリソース:

先頭に戻る