サインアップ

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

Signup クラスは、signup 画面の機能を提供します。この画面では、ユーザーの識別子とパスワードを入力します。テナントによっては、この識別子はメールアドレス、電話番号、またはユーザー名になります。

​

コンストラクタ

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

Example

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

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnSignup

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

tenant · TenantMembers

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

transaction · TransactionMembersOnSignup

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

username、email、roles などを含む、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.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>

このメソッドは、ソーシャルサインアップフォームの送信を処理します。signup メソッドと似ていますが、ソーシャルサインアップ用です。

Example

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

メソッドのパラメーター

表示 パラメーター

options

FederatedSignupPayloadOptions。

connection · string · 必須

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

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーがない場合は空の配列を返します。返されるのは、トランザクションコンテキスト内のエラーオブジェクトの配列です。

getSignupIdentifiers · Identifier [] | null

このメソッドは、サインアップフォームで有効な識別子の一覧を返し、トランザクション設定に基づいて各項目が必須か任意かを示します。識別子オブジェクトの配列です (例: email、phone、username) 。

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const identifiers = signupManager.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]

pickCountryCode · Promise<void>

このメソッドは、ユーザーを国コードの選択リストにリダイレクトし、そこで電話番号の国コードプレフィックスを更新できるようにします。

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.pickCountryCode();

signup · Promise<void>

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

Example

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

メソッドのパラメーター

表示 パラメーター

options

SignupPayloadOptions。

email? · string

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

username? · string

ユーザーの識別子。

phoneNumber? · string

ユーザーの電話番号。

password? · string

ユーザーのパスワード。

captcha? · string

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

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

ulp- をプレフィックスとして持つ追加のカスタムフィールド (例: 'ulp-custom-field') 。

validatePassword · PasswordValidationResult

このメソッドは、パスワードが有効かどうかと、その理由を示す PasswordValidationResult 型のオブジェクトを返します。

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validatePassword('P@$wOrd123!');

メソッド パラメーター

表示 パラメーター

password · string · 必須

ユーザーのパスワード。

validateUsername · UsernameValidationResult

このメソッドは、指定されたユーザー名を、トランザクションコンテキストで定義されている現在のユーザー名ポリシーに照らして検証します。返されるオブジェクトには、ユーザー名が有効かどうかと、その理由が示されます。

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validateUsername('myusername');
// result => { valid: true, errors: [] }

メソッド パラメーター

表示 パラメーター

username · string · 必須

検証するユーザー名の文字列。