options パラメータで設定できます。これらのオプションを使うと、Lock ウィジェットの動作、接続の扱い、プロジェクトで必要な追加のサインアップフィールド、言語やテキストの値、widget 上の色や画像など、さまざまな項目を変更できます。探しているものがわかっている場合は以下の目次を確認し、そうでない場合は各オプションを参照して詳細を確認してください。
UI
テーマ
options オブジェクトの theme プロパティにまとめられています。
認証
options オブジェクトの auth プロパティにまとめられています。
Database
Enterprise
パスワードレス
その他
UI オプション
allowAutocomplete
<input autocomplete />) を有効にするかどうかを指定します。デフォルトは false です。
allowAutocomplete: true
allowPasswordAutocomplete
<input autocomplete />) 。デフォルトはfalseです。
パスワードマネージャーに対応し、その他の望ましくない動作を避けるため、allowPasswordAutocompleteをtrueに設定してください。
allowPasswordAutocomplete: true
allowShowPassword
false です。
allowShowPassword: true
allowShowPassword を true に設定し、パスワードを表示するよう切り替えた Lock:

allowedConnections
signin|signup|reset アクションで使用する接続の配列です。デフォルトでは、有効な接続がすべて使用されます。
allowedConnections: ['Username-Password-Authentication']
allowedConnections: ['twitter', 'facebook', 'linkedin']
allowedConnections: ['qraftlabs.com']
allowedConnections の例:


autoclose
closableでない場合は、このオプションをtrueに設定していても閉じられません。
autoclose: true
autofocus
container オプションが指定されている場合の既定値は false、それ以外の場合は true です。
autofocus: false
avatar
avatar オプションを使えば、それらを任意の取得元から取得できます。
null を指定するだけです。
avatar: null
Gravatar を使用した場合のデフォルトの動作:

closable
container オプションが指定されている場合、この値は常に false です。それ以外の場合、デフォルトは true です。
closable: false

container
id です。
これにより、ウィジェットはモーダルのポップアップウィンドウではなく、div 内にインライン表示されます。

flashMessage
error または success のフラッシュメッセージを表示します。このオブジェクトには、次のプロパティがあります。
- type {String}: メッセージの種類。指定できる種類は
error、info、successです - text {String}: 表示するテキスト。
language
language: 'es'

languageDictionary
languageDictionary の値の完全な一覧については、英語版の Language Dictionary Specification を参照してください。

languageDictionary オプションの使用方法について詳しくは、エラーメッセージのカスタマイズ ページまたは 国際化 ページをご覧ください。
popupOptions
window.open で指定できる位置やサイズのオプションを任意に設定できます。既定値は です。
window.open の機能オプションです。これは redirect が false に設定されている場合にのみ適用されます。
rememberLastLogin
true です。この情報はユーザーの Auth0 セッションに基づくため、この機能は Auth0 セッションが有効な間利用できます (有効期間は設定可能です) 。
rememberLastLogin: false
新しいテナントでは、Seamless SSO が自動的に有効になります。これが有効になっている場合、セッションが存在すると ページ自体がまったく表示されないため、rememberLastLogin オプションは関係なくなります。Seamless SSO はシームレスな認証体験を提供するため、使用を強く推奨します。ユーザーは一度ログインすれば、作成したアプリケーション間を移動する場合でも、サードパーティ製アプリケーション間を移動する場合でも、再度資格情報を入力する必要がありません。ユーザーがログインしていない場合は、想定どおりログイン画面にリダイレクトされます。さらに、次の状況では 前回のサインインに使用したアカウント というメッセージは表示されません。
- セッションが パスワードレス認証 を使って確立された ホスト型ログインページ で Lock を使用した場合。
- 組み込みログイン で Lock を使用し、
responseType: code(Regular Web Apps で使用される 認可コードフロー を示します) を指定した場合。
scrollGlobalMessagesIntoView
globalMessage をユーザーの表示領域内にスクロールして表示するかどうかを指定します。デフォルトは true です。
scrollGlobalMessagesIntoView: false
テーマオプション
options オブジェクトの theme プロパティに分類されています。
- displayName {String}: ボタンのタイトルを作成する際に、接続名の代わりに表示する名前です (たとえば、login では
LOGIN WITH MYCONNECTION) 。 - primaryColor {String}: ボタンの背景色です。デフォルトは
#eb5424です。 - foregroundColor {String}: ボタンのテキスト色です。デフォルトは
#FFFFFFです。 - icon {String}: この接続のアイコンの URL です。例:
http://site.com/logo.png.
true で、false に設定すると代わりにアイコンが表示されます。

logo
logo の値には、Lock のヘッダーに表示される画像の URL を指定します。既定では Auth0 のロゴが使用されます。使い勝手を高めるため、推奨される最大の高さは 58px です。

primaryColor プロパティは、Lock のメインカラーを定義します。ウィジェットで使用されるすべての色は、この色をもとに計算されます。このオプションは、カスタムの logo を指定する際に、すべての色が logo のカラーパレットと自然に調和するようにするのに役立ちます。デフォルトは #ea5323 です。

認証オプション
options オブジェクトの auth プロパティにまとめられています。
Lock で使用されるデフォルトのスコープは openid profile email です。
audience
audience オプションは、認証後に受け取るを利用する API を示します。
autoParseHash
autoParseHash を true に設定すると、Lock はインスタンス化時に window.location.hash 文字列を解析します。false に設定した場合は、resumeAuth メソッドを使って手動で認証を再開する必要があります。
connectionScopes
params
login の開始時に、パラメーターを options オブジェクトに追加して送信できます。以下の例では、値が foo の state パラメーターを追加し、さらに scope パラメーターも追加しています (これには scope と、その後に要求する属性が含まれます) 。
redirect
redirectUrl
redirectUrl が指定されている場合 (空白でない値が設定されている場合) 、responseType を手動で設定していなければ、デフォルトで code になります。
responseMode
redirectUrl に送信する場合は、"form_post" に設定してください。
それ以外の場合、このオプションは省略してください。デフォルトでも省略されます。
responseType
responseType の値は、シングルページアプリケーションの場合は “token”、それ以外の場合は “code” に設定する必要があります。redirectUrl が指定されている場合のデフォルト値は “code”、それ以外の場合は “token” です。
responseType が code に設定されている場合、Lock では Last time you logged in with メッセージは表示されず、ユーザーには常に資格情報の入力が求められます。
sso
Database オプション
additionalSignUpFields
additionalSignUpFields オプションを使用すると、サインアップ画面に追加の入力フィールドを設定できます。この方法で追加した各オプションは、そのユーザーの user_metadata に追加されます。詳しくは、ユーザープロファイルでメタデータがどのように機能するかを理解する を参照してください。すべての入力には name と placeholder が必要で、icon の URL を指定することもできます。また、prefill オプションを使って初期値を指定することもでき、値を表す文字列またはその値を取得する関数を設定できます。そのほかのオプションはフィールドの型によって異なります。型は type オプションで定義し、デフォルトは “text” です。
Option additionalSignUpFields Intended for use with database signup only
additionalSignUpFields は、database signup でのみ使用することを想定しています。Social sign up も使用している場合は、ユーザーのサインアップ後に追加情報の入力を求めることができます (詳しくは、カスタム signup に関するページを参照してください) 。これらの案内を表示するには、databaseAlternativeSignupInstructions i18n キーを使用できます。テキストフィールド
validator 関数も指定できる点に注意してください。
validator を指定しない場合、このテキストフィールドは必須になります。テキストフィールドを任意にするには、次のように常に true を返すバリデーターを使用します。
storage: 'root' を使用します。ただし、この方法で保存できる値は一部に限られます。ルートプロファイルに追加できる属性の一覧はこちらです。デフォルトでは、追加のサインアップフィールドはすべて user_metadata オブジェクト内に保存されます。

選択フィールド
type: "select" を指定すると、ユーザーが値を選択できる select 要素を使用できます。
select フィールドの options 配列の項目は、次の形式に従う必要があります。
{label: “non empty string”, value: “non empty string”}。また、少なくとも 1 つのオプションを定義する必要があります。
options と prefill の値は、関数を使って指定できます。
チェックボックスフィールド
type: "checkbox" です。prefill の値では、チェックボックスのデフォルト状態 (true または false) を指定でき、この値は必須です。
type: "hidden" を使うと、固定値を持つ隠し入力を利用できます。
additionalSignUpFields のデータをメールテンプレートで利用できる場合があり、その値を使ってテンプレート化されたメールの言語を設定できます。
allowLogin
false に設定すると、ウィジェットにログイン画面は表示されません。これは、ウィジェットをサインアップ専用で使用したい場合 (サインアップ画面の login タブと signup タブは非表示になります) や、パスワードをリセットしたい場合 (forgot password screen の戻るボタンは非表示になります) に便利です。このような場合は、initialScreen、allowForgotPassword、allowSignUp オプションも指定する必要があることがあります。デフォルトは true です。
allowLogin: false

allowForgotPassword
allowForgotPassword によりログイン画面の「パスワードを忘れましたか?」リンクが非表示になり、Forgot Password 画面にアクセスできなくなります。既定値は true です。change password スクリプトのないカスタムデータベースを使用するデータベース接続では、Forgot Password 画面は利用できません。
allowForgotPassword: false

allowSignUp
false に設定すると、ログイン画面のログインタブとサインアップタブが非表示になり、サインアップ画面へアクセスできなくなります。デフォルトは true です。なお、データベース接続でサインアップが無効になっている場合や、Create スクリプトのない Custom database を使用している場合は、サインアップ画面は利用できません。
また、このオプションで制御できるのはクライアント側の見た目のみであり、その気になれば匿名の訪問者による新規サインアップを完全に防げるわけではない点にも注意してください。新規ユーザーのサインアップを完全に防ぎたい場合は、ダッシュボードの接続設定で Disable Sign Ups オプションを使用する必要があります。
allowSignUp: false

defaultDatabaseConnection
defaultDatabaseConnection: 'test-database'
initialScreen
login、signUp、forgotPassword です。このオプションを指定しない場合、ウィジェットはその一覧の中で利用可能な最初の画面を表示します。
initialScreen: 'forgotPassword'
loginAfterSignUp
true です。
loginAfterSignUp: false
forgotPasswordLink
forgotPasswordLink: 'https://yoursite.com/reset-password'
showTerms
true に設定すると、languageDictionary.signUpTerms 文字列が表示されます。既定値は true です。
showTerms: false
mustAcceptTerms
true に設定すると、利用規約とともにチェックボックスが表示され、サインアップする前にチェックする必要があります。利用規約は languageDictionary オプションで指定できます。このオプションが有効なのは、データベース接続でサインアップするユーザーのみです。デフォルトは false です。
mustAcceptTerms: true
prefill
signUpLink
allowSignUp は true に設定されます。
signUpLink: 'https://yoursite.com/signup'
usernameStyle
requires_username フラグが設定されたデータベース接続で、ユーザーの識別に何を使用するかを指定します (このフラグが設定されていない場合、usernameStyle オプションは無視されます) 。指定できる値は "username" と "email" です。デフォルトでは username と email の両方を使用できますが、このオプションを設定すると、ログイン時に使用できるのはどちらか一方のみになります。
usernameStyle: 'username'
エンタープライズ向けオプション
defaultEnterpriseConnection
defaultDatabaseConnection が指定されている場合は、データベース接続が使用され、このオプションは無視されます。
defaultEnterpriseConnection: 'test-database'
defaultADUsernameFromEmailPrefix
true です。
defaultADUsernameFromEmailPrefix: false
パスワードレスオプション
passwordlessMethod
Auth0LockPasswordless を使用する場合、このオプションで、ユーザーの認証に コード と マジックリンク のどちらを送信するかを選択できます。メール接続で使用できる値は code と link です。既定値は code です。SMS 接続では、常に code が使用されます。
passwordlessMethod: code
その他のオプション
configurationBaseUrl
configurationBaseUrl: "https://www.example.com"
languageBaseUrl
https://cdn.auth0.com を使用します。提供されている翻訳はすべてここに保存されているためです。別の値を指定すると、必要に応じて翻訳の取得元として別のソースを使用できます。
languageBaseUrl: "https://www.example.com"
hashCleanup
hashCleanup オプションを有効にすると、ユーザーの認証後、コールバックURLのハッシュ部分が削除されます。デフォルトは true です。
hashCleanup: false
connectionResolver
username、context、callback を受け取ります。コールバックには、{type: 'database', name: 'connection name'} のようなオブジェクトを渡すことを想定しています。これはデータベース接続でのみ機能します。 このリゾルバーは Form の onSubmit イベントで実行されるため、できるだけシンプルで高速に保ってください。
これはベータ機能です。バグを見つけた場合は、GitHub で issue を作成してください。
leeway
leeway オプションには整数 (秒単位の値) を設定でき、 の有効期限におけるクロックスキューを考慮するために使用できます。通常、この値は長くても 1〜2 分程度です。
leeway: 30