Lock の認証パラメータ

認証パラメータの設定に関する Lock のドキュメント。

ログインを開始するときに、options object にパラメータを追加して送信できます。以下の例では、state パラメータに 'foo' という値を追加しています。

var options = {
  auth: {
    params: {state: 'foo'},
  }
};

上記の例は、https://{yourDomain}/authorize?state=foo&... でログインを開始するのと同等です。

次のパラメータがサポートされています：scope、device、nonce、state。

サポート対象のパラメータ

スコープ

var options = {
  auth: {
    params: {scope: 'openid email user_metadata app_metadata picture'},
  }
};

scope で使用できる値はいくつかあります。JWTs は API へのすべてのリクエストで送信されるため、できるだけ小さくしておくことをおすすめします。

Lock のデフォルトの scope 値は openid profile email です。この最小限のスコープ値は、Last time you logged in with 機能を正しく動作させるために必要です。

Lock をローカルで実行する

Lock の初期化時に、少なくともデフォルトのスコープ openid profile email を手動で指定せず、Web サイトを http://localhost または http://127.0.0.1 で実行している場合、ブラウザーのコンソールに次のエラーが表示されます。

Consent required. When using getSSOData, the user has to be authenticated with the following scope: openid profile email

アプリケーションを本番環境で実行している場合、または openid profile email スコープを指定している場合は、この問題は発生しません。詳しくは、ユーザーの同意とサードパーティアプリケーション のドキュメントを参照してください。

スコープの詳細については、scopes のドキュメントページ を参照してください。

例: トークンを取得する

Lock で、ユーザーのプロファイルデータを取得できるトークンを受け取るには、scope パラメータを追加する必要があります。

var options = {
  auth: {
    params: {
        scope: 'openid profile'
    }
  }
};

Lock には connectionScopes という設定オプションもあり、これを使うと特定の接続に対するスコープを指定できます。これは、最初は一連のスコープ (ダッシュボードで定義) で開始し、後から特定の接続に対して追加の権限や属性を要求したい場合に便利です。詳しくは、Lock Configuration Options ページを参照してください。

state

state パラメーターは、リダイレクト後も維持される任意の state 値です。XSRF 攻撃の軽減や、認証プロセスの完了後に必要になる可能性がある 戻り先の URL などのコンテキスト情報の保持に役立ちます。カスタムの state パラメーターが指定されていない場合は、Lock が自動的に生成します。詳しくは、State Parameter を参照してください。

nonce

nonce パラメータはリプレイ攻撃の防止に使用され、カスタム値が指定されていない場合は Lock によって自動的に生成されます。

device

device パラメータは、認証を要求するデバイスまたはブラウザーの名前を指定します。