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

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

screen · ScreenMembers

設定やコンテキストなど、redeem-ticket 画面に固有の詳細が含まれます。

tenant · TenantMembers

id や関連するメタデータなど、tenant に関するデータが含まれます。

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

redeem ticket フロー中のユーザー入力など、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 · 必須

使用する言語の locale コードです (例：'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 []

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