OrganizationSelection

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

OrganizationSelection クラスは、organization-selection 画面の機能を実装します。この画面では、ユーザーは続行先の 組織 を選択できます。

​

コンストラクター

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

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

organization-selection 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnOrganizationSelection

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

tenant · TenantMembers

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

transaction · TransactionMembers

現在有効な識別子やフローの状態など、organization-selection 画面に関するトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

組織選択フロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
organizationSelectionManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

使用する言語のlocaleコード (たとえば、'en'、'fr'、'es') 。

persist? · "session"

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

continueWithOrganizationName · Promise<void>

このメソッドは、選択した組織名を使用して続行します。

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

メソッドのパラメータ

表示 パラメータ

options

ContinueWithOrganizationNameOptions。

organizationName · string · 必須

続行に使用する組織の名前。

getErrors · Error []

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