OrganizationSelection

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

organization-selection 画面は、認証フローを続行するためにユーザーが organization名を入力する必要がある場合に表示されます。ユーザーは organization名を入力して次に進むことができます。

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は、各画面で partial import と root import をサポートしています。

• partial import を使用すると、特定の用途に必要なコードだけを含めることができます。
• root import を使用すると、すべての画面を単一のバンドルから読み込めるため、想定されるあらゆる画面を 1 つの統一されたビルドで処理したい場合に便利です。

Import Example

// ルートインポート
import { useOrganizationSelection } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  useOrganizationSelection,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continueWithOrganizationName,
} from '@auth0/auth0-acul-react/organization-selection';

function OrganizationSelectionScreen() {
  const { continueWithOrganizationName } = useOrganizationSelection();
  return (
    <button onClick={() => continueWithOrganizationName({ organizationName: 'my-org' })}>Continue</button>
  );
}

​

Context Hooks

organization-selection 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。@auth0/auth0-acul-react/organization-selection からインポートします。

useBranding · () => BrandingMembers

このフックは、organization-selection 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/organization-selection';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/organization-selection';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、選択対象が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

import { useOrganization } from '@auth0/auth0-acul-react/organization-selection';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フロー内の現在の prompt に関するデータが含まれます。

Example

import { usePrompt } from '@auth0/auth0-acul-react/organization-selection';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnOrganizationSelection

このフックには、設定やコンテキストを含む、organization-selection 画面固有の詳細情報が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/organization-selection';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連するメタデータなど、テナントに関するデータが含まれます。

Example

import { useTenant } from '@auth0/auth0-acul-react/organization-selection';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフロー状態など、organization-selection 画面におけるトランザクション固有のデータを提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/organization-selection';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL のクエリ文字列から事前入力されたパラメーターなど、画面に渡された信頼できないデータを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/organization-selection';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在アクティブなユーザーの詳細を提供します。

Example

import { useUser } from '@auth0/auth0-acul-react/organization-selection';
function UserProfile() {
  const user = useUser();
}

useOrganizationSelection · OrganizationSelectionMembers

このフックは、organization-selection 画面で利用できるすべてのメソッドとコンテキストを返します。

​

メソッド

continueWithOrganizationName · Promise<void>

このメソッドは、ユーザーが入力したorganization名を送信して、認証フローを続行します。

Example

import { useOrganizationSelection } from '@auth0/auth0-acul-react/organization-selection';

function ContinueButton() {
  const { continueWithOrganizationName } = useOrganizationSelection();
  return (
    <button onClick={() => continueWithOrganizationName({ organizationName: 'my-org' })}>
      Continue
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

ContinueWithOrganizationNameOptions。

organizationName · string · 必須

続行する組織のorganization名。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと状態を取得します。

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者の各エラーを読み取り、管理します。