ログアウト

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

Logout クラスは、logout 画面の機能を実装します。この画面では、ユーザーはログアウトするかどうかを確認またはキャンセルできます。

​

コンストラクター

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

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.confirmLogout({
  action: 'accept',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

構成やコンテキストなど、logout 画面固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

confirmLogout · Promise<void>

このメソッドは、ログアウト操作を確定します (承認または拒否) 。

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.confirmLogout({
  action: 'accept',
});

メソッドパラメーター

表示 パラメーター

options

ConfirmLogoutOptions。

action · "accept" | "deny" · 必須

認証トランザクションの state です。

getErrors · Error []

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