サインアップ

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

Signup クラスは、signup 画面の機能を提供します。この画面では、新しいアカウントを作成するためにユーザーの資格情報を収集します。テナントによっては、識別子としてメールアドレス、電話番号、またはユーザー名を使用できます。また、ソーシャルまたはエンタープライズ接続を介したフェデレーションサインアップと Google One Tap もサポートしています。

​

コンストラクター

サインアップ画面マネージャーのインスタンスを作成します:

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

認証フローにおける現在の prompt に関するデータが含まれます。

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' に設定すると、選択した言語はセッション中保持されます。

federatedSignup · Promise<void>

このメソッドは、サインアップのためにユーザーを ソーシャル または Enterprise Identity Provider (IdP) にリダイレクトします。

Example

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

メソッドのパラメーター

表示 パラメーター

options

FederatedSignupPayloadOptions。

connection · string · 必須

ソーシャル または Enterprise Identity Provider の接続名です。

getErrors · Error []

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

getSignupIdentifiers · Identifier [] | null

このメソッドは、サインアップ フォームで有効な 識別子 の一覧を返し、トランザクション の設定に基づいて各項目が必須か任意かを示します。識別子 object の配列です (例: 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 }]

googleOneTap · Promise<void>

このメソッドは、Google One Tap の認証情報を使用して新しいユーザーを登録し、別のページへのリダイレクトなしでワンクリックによるサインアップを可能にします。

Google One Tap のプロンプトをレンダリングする前に、screen.googleOneTapConfig を確認してください。この機能がサーバー側で有効になっていない場合、値は null です。

Example

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.googleOneTap({ one_tap_credential: credential });

メソッドのパラメーター

表示 パラメーター

one_tap_credential · string · 必須

Google Identity Services のプロンプトから返される Google One Tap の認証情報トークンです。

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

CAPTCHA コードまたは CAPTCHA プロバイダーからの応答。Auth0 テナントで ボット検出が有効になっている場合、このプロパティは必須です。

[`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 · 必須

バリデーション対象のユーザー名文字列。