Skip to main content
以下のオプションを使用して、Android 向け Lock の機能とデザインを設定できます。 設定オプションは、次の形式で Lock Builder に追加します。 
val lock = Lock.newBuilder(account, callback)
    // 設定オプション
    .closable(true)
    .allowSignUp(false)
    .setPrivacyURL('http://example.com/privacy')
    .setTermsURL('http://example.com/terms')
    // 設定オプションここまで
    .build(this)

​
一般オプション

  • closable(boolean): LockActivity を閉じられるかどうかを指定します。デフォルトでは閉じられません。
  • allowedConnections(List): Dashboard で設定された一覧から、許可する接続を絞り込みます。デフォルトでは、この値が空の場合、Dashboard で定義されているすべての接続が利用可能です。
  • hideMainScreenTitle(boolean): true に設定すると、メイン画面のヘッダーにタイトルが表示されなくなります。

​
認証オプション

  • withAuthenticationParameters(Map<String, Object>): 各ログインおよびサインアップの呼び出し時に送信する追加の認証パラメーターを定義します。認証呼び出しで使用されるデフォルトの scope は openid です。別の値を指定する場合は、withAuthenticationParameters を使用して、scope キーに別の値を追加します。
  • withScope(String): 認証リクエストの実行時に要求するスコープを変更します。
  • withAudience(String): 認証リクエストの実行時に要求する を変更します。

​
データベースオプション

  • withUsernameStyle(int): メールアドレスのみ、ユーザー名のみ、またはその両方を入力させるかどうかを指定します。指定できる値は USERNAME と EMAIL です。デフォルトでは、パラメーター requires_username の Dashboard 設定に従います。
  • loginAfterSignUp(boolean): SignUp イベントの後に、ユーザーを自動的にログインさせるかどうかを指定します。デフォルトは true です。
  • initialScreen(int): Lock の起動時に最初に表示するフォームをカスタマイズできます。指定できる値は LOG_IN、SIGN_UP、FORGOT_PASSWORD です。デフォルトの初期画面は LOG_IN です。
  • allowSignUp(boolean): データベース接続が設定されており、Dashboard で許可されている場合にサインアップフォームを表示します。デフォルトは true です。
  • allowLogIn(boolean): データベース接続が設定されている場合にログインフォームを表示します。デフォルトは true です。
  • allowForgotPassword(boolean): データベース接続が設定されており、Dashboard で許可されている場合にパスワード再設定フォームを表示します。デフォルトは true です。
  • allowShowPassword(boolean): パスワードフィールドの入力内容の表示/非表示を切り替えるボタンを表示します。デフォルトは true です。
  • setDefaultDatabaseConnection(String): デフォルトのデータベース接続を指定します。これは、アプリケーションに複数のデータベース接続が設定されている場合に便利です。
  • enableEnterpriseWebAuthenticationFor(List): クリック時にブラウザー経由の Web 認証フローを開始するエンタープライズ接続を絞り込みます。使用できるストラテジーは ‘ad’、‘adfs’、‘waad’ のみです。
  • withSignUpFields(List): サインアップ画面でユーザー名/メールアドレスとパスワードの入力が完了した後に、ユーザーが追加フィールドを入力するための 2 つ目の画面を表示します。この方法で送信された値は、ルート属性または user_metadata 属性を使ってユーザープロファイルに保存できます。詳細は、Lock Android: Signup 時のカスタムフィールド を参照してください。
  • setPrivacyURL(String): プライバシーポリシーの URL をカスタマイズできます。デフォルトは https://auth0.com/privacy です。
  • setTermsURL(String): 利用規約の URL をカスタマイズできます。デフォルトは https://auth0.com/terms です。
  • setSupportURL(String): Lock で回復不能なエラーが発生した場合に表示するサポート URL を設定できます。
  • setMustAcceptTerms(boolean): サインアップ前に、利用規約とプライバシーポリシーへの同意を必須にします。デフォルトは false です。
  • useLabeledSubmitButton(boolean): true に設定すると、送信ボタンにはアイコンの代わりに現在のモード (sign up / log in) のラベルが表示されます。デフォルトは true です。hideMainScreenTitle オプションが true に設定されている場合、この設定は無視され、いずれにしてもラベルが使用されます。

​
OAuth オプション

  • withAuthStyle(String, int): 指定した接続 (名前) の外観と操作感を、特定のスタイルでカスタマイズします。詳細については、カスタム OAuth 接続に関するこちらのドキュメントを参照してください。
  • withConnectionScope(String, String…): 指定した接続名に対して追加のスコープを指定できます。これらのスコープは、Auth0 Dashboard の接続設定で定義されているスコープとあわせてリクエストされます。スコープは一切検証されないため、指定した認証プロバイダーで認識される必要があります。一覧については、該当する接続の設定を Auth0 Dashboard で確認してください。
  • withScheme(String): authorize 呼び出しで送信される redirect_uri のスキームを変更できます。デフォルトのスキームは https です。この設定を変更する場合は、auth0Scheme のマニフェストプレースホルダーと、Auth0 アプリケーションの Dashboard にある “Allowed Callbacks URLs” も更新する必要があります。

​
パスワードレスのオプション

  • useCode(): 認証では、メール/SMS でリンクの代わりに code を送信します。
  • useLink(): パスワードレス認証では、メール/SMS で code の代わりにリンクを送信します。
  • rememberLastLogin(boolean): 前回成功した認証で使用したメールアドレスまたは電話番号を保存し、次回パスワードレス認証が要求されたときに自動ログインするかどうか。