AcceptInvitation

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

AcceptInvitation クラスは、accept-invitation 画面の機能を実装します。この画面は、ユーザーが組織への招待を承諾する必要がある場合に表示されます。

​

コンストラクター

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

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
await acceptInvitationManager.acceptInvitation();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

accept-invitation 画面の id、name、logoUrl など、クライアントに関する設定情報を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnAcceptInvitation

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

招待の承諾フロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細を含みます。

​

メソッド

acceptInvitation · Promise<void>

このメソッドは招待を承諾し、ユーザーを組織に追加します。

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
await acceptInvitationManager.acceptInvitation();

changeLanguage · Promise<void>

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

Example

import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';
const acceptInvitationManager = new AcceptInvitation();
acceptInvitationManager.changeLanguage({
  language: 'fr',
});

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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