AcceptInvitation

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

accept-invitation 画面は、ユーザーが組織への参加に招待されたときに表示されます。ユーザーはこの画面で招待を承諾し、認証フローに進むことができます。

​

インポート

各画面には、それぞれ固有のHooksとメソッドがあります。SDK は、各画面で部分インポートとルートインポートをサポートしています。

• 部分インポートを使うと、特定の用途に必要なコードだけを含めることができます。
• ルートインポートを使うと、1 つのバンドルからすべての画面を読み込めるため、想定されるすべての画面に対応する単一のビルドを使いたい場合に便利です。

Import Example

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

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

function AcceptInvitationScreen() {
  const { acceptInvitation } = useAcceptInvitation();
  return (
    <button onClick={() => acceptInvitation()}>Accept Invitation</button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

このフックは、ユーザーが参加するよう招待された組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnAcceptInvitation

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの状態など、accept-invitation 画面における transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useAcceptInvitation · AcceptInvitationMembers

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

​

メソッド

acceptInvitation · Promise<void>

このメソッドは、ユーザーが組織への招待を承諾したことを送信し、認証フローを続行します。

Example

import { useAcceptInvitation } from '@auth0/auth0-acul-react/accept-invitation';

function AcceptButton() {
  const { acceptInvitation } = useAcceptInvitation();
  return (
    <button onClick={() => acceptInvitation()}>
      Accept Invitation
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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