SignupId

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

SignupId クラスは、signup-id 画面の機能を提供します。この画面では、複数ステップのサインアップフローの最初のステップとして、メールアドレス、ユーザー名、電話番号などのユーザー識別子を収集します。また、ソーシャルまたはエンタープライズ接続、および Google One Tap を介したフェデレーションサインアップもサポートしています。

​

コンストラクター

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

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: '[e-mail]',
});

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、branding に関する構成を提供します。

client · ClientMembers

signup-id 画面向けに、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnSignupId

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

tenant · TenantMembers

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

transaction · TransactionMembersOnSignupId

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

使用する言語の locale コードです (例: 'en'、'fr'、'es') 。

persist? · "session"

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

federatedSignup · Promise<void>

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

Example

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

メソッドパラメータ

表示 パラメータ

options

FederatedSignupOptions。

connection · string · 必須

Social または Enterprise Identity Provider の接続名です。

getErrors · Error []

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

getSignupIdentifiers · Identifier [] | null

このメソッドは、signup-id form で有効になっている 識別子 の一覧を返し、トランザクション設定に基づいてそれぞれが必須か任意かを示します。返されるのは、識別子 オブジェクトの配列です (例: email、phone、username) 。

Example

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

googleOneTap · Promise<void>

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

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

Example

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

メソッドパラメータ

表示 パラメータ

one_tap_credential · string · 必須

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

pickCountryCode · Promise<void>

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

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.pickCountryCode();

signup · Promise<void>

このメソッドは、signup-id に関連する設定を処理します。さまざまな 識別子 を使って新規ユーザーをサインアップできます。

Example

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: '[e-mail]',
});

メソッドパラメータ

表示 パラメータ

options

SignupOptions。

email? · string

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

username? · string

ユーザーの 識別子 です。

phone? · string

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

captcha? · string

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

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

ulp- で始まる追加のカスタムフィールドです (例: 'ulp-custom-field') 。

validateUsername · UsernameValidationResult

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

Example

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

メソッドパラメータ

表示 パラメータ

username · string · 必須

バリデーションするユーザー名文字列です。