OrganizationPicker

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

OrganizationPicker クラスは、organization-picker 画面の機能を実装します。この画面では、利用可能な組織の一覧からユーザーが組織を選択できます。

​

コンストラクター

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

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.selectOrganization({ organization: 'org_XXXXXXXXXXXXXXX' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

selectOrganization · Promise<void>

このメソッドは、選択した組織 ID を送信します。

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.selectOrganization({ organization: 'org_XXXXXXXXXXXXXXX' });

メソッドパラメーター

表示 パラメーター

options

SelectOrganizationOptions。

organization · string · 必須

選択する組織の ID です。

state? · string

リクエストに含める任意の state 値です。

skipOrganizationSelection · Promise<void>

このメソッドは、組織の選択をスキップするアクションを送信します。

Example

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPickerManager = new OrganizationPicker();
await organizationPickerManager.skipOrganizationSelection();