SignupId

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

SignupId クラスは、signup-id 画面の機能を実装します。この画面では、ユーザーの識別子を入力します。

​

コンストラクター

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

Example

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

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

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

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

persist? · "session"

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

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

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

federatedSignup · Promise<void>

このメソッドは、Google や Facebook などの各種ソーシャル ID を使用したサインアップを処理します。

Example

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

メソッドパラメーター

表示 パラメーター

options

FederatedSignupOptions。

connection · string · 必須

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

getErrors · Error []

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

getSignupIdentifiers · Identifier [] | null

このメソッドは、signup-id フォームで有効な識別子の一覧を返します。各識別子には、トランザクション設定に基づいて必須か任意かが示されます。戻り値は識別子オブジェクトの配列です (例: 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 }]

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

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

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

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

validateUsername · UsernameValidationResult

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

Example

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

メソッドパラメーター

表示 パラメーター

username · string · 必須

検証する username 文字列。