OrganizationPicker

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

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

​

コンストラクター

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

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

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

persist? · "session"

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

getErrors · Error []

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

selectOrganization · Promise<void>

このメソッドは、選択したorganizationの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 · 必須

選択するorganizationのID。

state? · string

リクエストに含める省略可能なstate値。

skipOrganizationSelection · Promise<void>

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

Example

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