SignupPassword

Universal Login の signup-password 画面をカスタマイズするために使用できるプロパティとメソッドをすべて説明します。

SignupPassword クラスは、signup-password 画面の機能を実装します。この画面では、ユーザーがパスワードを入力します。

​

コンストラクター

SignupPassword 画面マネージャーのインスタンスを作成します：

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: '[e-mail]',
  password: 'P@$wOrd123!',
});

​

プロパティ

branding · BrandingMembers

ブランディングテーマや各種設定など、ブランディング関連の設定を提供します。

client · ClientMembers

signup-password 画面の id、name、logoUrl など、クライアント関連の設定を提供します。

organization · OrganizationMembers

id や name など、ユーザーの組織に関する情報を提供します。

prompt · PromptMembers

認証フロー内の現在のプロンプトに関するデータを含みます。

screen · ScreenMembersOnSignupPassword

設定やコンテキストなど、signup-password 画面に固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータを含みます。

transaction · TransactionMembersOnSignupPassword

アクティブな識別子やフローの状態など、トランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

ログイン時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細を含みます。

​

メソッド

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語はセッションの間保持されます。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- を接頭辞とする追加のカスタムフィールドです (例: 'ulp-custom-field') 。

federatedSignup · Promise<void>

このメソッドでは、Google や Facebook などの各種ソーシャル ID を使ってサインアップできます。

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.federatedSignup({
  connection: 'google-oauth2',
});

メソッドパラメーター

表示 パラメーター

options

FederatedSignupPasswordPayloadOptions。

connection · string · 必須

使用するソーシャル接続の名前です。

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーが存在しない場合は、空の配列を返します。

signup · Promise<void>

このメソッドは、サインアップ用パスワードフォームの送信を処理します。

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: '[e-mail]',
  password: 'P@$wOrd123!',
});

メソッドパラメーター

表示 パラメーター

options

SignupPasswordOptions。

email? · string

ユーザーのメールアドレスです。

username? · string

ユーザーの識別子です。

phoneNumber? · string

ユーザーの電話番号です。

password · string · 必須

ユーザーのパスワードです。

captcha? · string

キャプチャのコード、またはキャプチャプロバイダーからのレスポンスです。Auth0 テナントで Bot Detection が有効になっている場合、このプロパティは必須です。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- を接頭辞とする追加のカスタムフィールドです (例: 'ulp-custom-field') 。

switchConnection · Promise<void>

このメソッドは、signup-password フロー中に認証接続を切り替えます。

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.switchConnection({
  connection: 'Username-Password-Authentication',
});

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsSignupPassword。

connection · string · 必須

signup-password 認証フロー中に切り替える接続識別子です。

[`key`: `string`] · "string" | "number" | "boolean"

ulp- を接頭辞とする追加のカスタムフィールドです (例: 'ulp-custom-field') 。

validatePassword · PasswordValidationResult

このメソッドは、パスワード文字列を現在のトランザクションのパスワードポリシーに照らして検証します。パスワードが有効かどうかと、その理由を示すオブジェクトを返します。

Example

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
const result = signupPasswordManager.validatePassword('MyP@ssw0rd!');

メソッドのパラメーター

表示 パラメーター

password · string · 必須

検証対象のパスワード文字列。