RedeemTicket

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

RedeemTicket クラスは、redeem-ticket 画面の機能を実装します。この画面は、認証フローを続行するためにユーザーがチケットを利用する必要がある場合に表示されます。

​

コンストラクター

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

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
await redeemTicketManager.continue();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

構成やコンテキストを含む、redeem-ticket 画面固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

チケット引き換えフロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在アクティブなユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
redeemTicketManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、redeem-ticket 画面で既定のアクションを実行し、認証フローを続行します。

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
await redeemTicketManager.continue();

getErrors · Error []

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