Lock APIのリファレンス

• new Auth0Lock-ロックのインスタンス化
• getUserInfo()-ログインしているユーザーのプロファイルの取得
• show() - Lockウィジェットの表示
• on() - イベントのリッスン
• resumeAuth() - autoParseHashがfalseの場合に認証フローを完了するために使用します
• checkSession() - 認証済みユーザーのAuth0から新しいトークンを取得します
• logout() - ユーザーのログアウト

​

Auth0LockPasswordless

• clientId {String} :必須パラメーター。Auth0のアプリケーションのclientId。
• ドメイン :必須パラメーター。Auth0ドメイン。通常は、your-account.auth0.comです。
• オプション {Object} :オプションのパラメーター。ロックの外観と動作を構成できます。詳細については、構成オプションのページを参照してください。

​

getUserInfo()

• accessToken ：ユーザートークン。
• コールバック :ユーザープロファイルが取得された後に呼び出されます。

lock.getUserInfo(accessToken, function(error, profile) {
  if (!error) {
    alert("hello " + profile.name);
  }
});

​

show()

• allowedConnections
• auth.params
• allowLogin
• allowSignUp
• allowForgotPassword
• initialScreen
• rememberLastLogin

// Show the Lock widget, without overriding any options
lock.show();

// Show the Lock widget, overriding some options
lock.show({
  allowedConnections: ["twitter", "facebook"],
  allowSignUp: false
});

​

flashMessage

• タイプ {String}:メッセージタイプ。エラーまたは成功のいずれかである必要があります。
• テキスト {String}:表示するテキスト。

lock.show({
  flashMessage:{
    type: 'success',
    text: 'Amazing Success!!'
  }
});

lock.on('authorization_error', function(error) {
  lock.show({
    flashMessage: {
      type: 'error',
      text: error.errorDescription
    }
  });
});

​

hide()

// Listen for authenticated event and hide Lock
lock.on("authenticated", function() {
  lock.hide();

  // Whatever else you'd like to do on authenticated event

});

​

on()

• Show:show: Lockが表示されたときに生成されます。引数はありません。
• hide: Lockが非表示のときに生成されます。引数はありません。
• unrecoverable_error: 接続が利用できないなど、回復できないエラーが発生したときに生成されます。唯一の引数はエラーです。
• authenticated: 認証が成功した後に生成されます。唯一の引数は認証結果です。認証結果にはトークンが含まれ、このトークンを使用してユーザーのプロファイルを取得したり、次回以降のログインに使用したりすることができます。
• authorization_error:認可が失敗したときに生成されます。唯一の引数はエラーです。
• hash_parsed: 新しいAuth0Lockオブジェクトがリダイレクトモード（デフォルト）で初期化されるたびに、ログイン試行の結果を探してurlのハッシュ部分を解析しようとします。これは高度な使用例のための低レベルのイベントであり、可能な場合は認可済みとauthorization_errorを優先する必要があります。その後、ハッシュ内に何も見つからなかった場合、このイベントはnullと共に生成されます。これは、ログインが成功した後に認可済みイベントと同じ引数を使用して、または何か問題が発生した場合にauthorization_errorと同じ引数を使用して生成されます。このイベントは、urlのハッシュ部分を解析する必要がないため、ポップアップモードでは生成されません。
• forgot_password ready:「パスワードを忘れた」場合、画面が表示されたときに生成されます。(バージョン>10.18)
• forgot_password submit:「パスワードを忘れた」場合、画面の送信ボタンをクリックしたときに生成されます。(バージョン>10.14)
• signin ready:「サインイン」画面が表示されたときに生成されます。
• signup ready:「サインアップ」画面が表示されたときに生成されます。
• signin submit: ユーザーが「ログイン」画面の送信ボタンをクリックしたときに生成されます。(バージョン>10.18)
• signup submit: ユーザーが「サインアップ」画面の送信ボタンをクリックしたときに生成されます。(バージョン>10.18)
• federated login: ソーシャル接続ボタンをクリックしたときに生成されます。引数として接続名と戦略を持ちます。(バージョン>10.18)
• socialOrPhoneNumber ready: ソーシャル+電話番号を使用したパスワードレス画面が表示されたときに生成されます
• socialOrPhoneNumber submit: ソーシャル+電話番号を使用したパスワードレス画面が送信されたときに生成されます
• socialOrEmail ready: ソーシャル+電子メールを使用したパスワードレス画面が表示されたときに生成されます
• socialOrEmail submit: ソーシャル+電子メールを使用したパスワードレス画面が送信されたときに生成されます
• vcode ready: ワンタイムパスワードを使用したパスワードレス画面が表示されたときに生成されます
• vcode submit: ワンタイムパスワードを使用したパスワードレス画面が送信されたときに生成されます

​

resumeAuth()

• hash {String}:リダイレクトから受信したハッシュフラグメント。
• コールバック :解析が完了した後に呼び出されます。最初の引数としてエラー（存在する場合）があり、2番目の引数として認証結果があります。使用できるハッシュがない場合は、両方の引数がnullになります。

lock.resumeAuth(hash, function(error, authResult) {
  if (error) {
    alert("Could not parse hash");
  }
  //This is just an example; you should not log Access Tokens in production.
  console.log(authResult.accessToken);
});

​

checkSession()

• オプション {Object}:オプション。通常は/authorizeに送信される有効なOAuth2パラメーターを受け入れます。省略した場合は、Auth0の初期化時に指定されたパラメーターが使用されます。
• コールバック :トークンの更新結果で呼び出されます。最初の引数としてエラー（存在する場合）があり、2番目の引数として認証結果があります。

lock.checkSession({}, function(err, authResult) {
  // handle error or new tokens
});

​

logout()

• オプション {Object}:これはオプションであり、auth0.js logout()と同じルールに従います。

lock.logout({
  returnTo: 'https://myapp.com/bye-bye'
});