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

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

prompt · PromptMembers

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

screen · ScreenMembersOnSignupPassword

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

tenant · TenantMembers

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

transaction · TransactionMembersOnSignupPassword

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

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

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

persist? · "session"

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

federatedSignup · Promise<void>

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

Example

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

メソッドのパラメータ

表示 パラメータ

options

FederatedSignupPasswordPayloadOptions。

connection · string · 必須

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

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

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

[`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 認証フロー中に切り替える接続識別子です。

validatePassword · PasswordValidationResult

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

Example

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

メソッドのパラメータ

表示 パラメータ

password · string · 必須

検証するパスワード文字列です。