DeviceCodeActivationAllowed

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

device-code-activation-allowed 画面は、ユーザーがデバイスのアクティベーションに成功した後に表示されます。デバイスが認可され、アクティベーションフローが完了したことを示します。

​

インポート

各画面には、それぞれ独自のフックとメソッドがあります。SDK は、各画面ごとに部分インポートとルートインポートをサポートしています。

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

Import Example

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

// 部分インポート
import {
  useDeviceCodeActivationAllowed,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
} from '@auth0/auth0-acul-react/device-code-activation-allowed';

function DeviceCodeActivationAllowedScreen() {
  const { screen } = useDeviceCodeActivationAllowed();
  return <p>Device successfully activated on {screen.name}</p>;
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、device-code-activation-allowed 画面の id、name、logoUrl など、クライアントに関連する構成を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、デバイスのアクティベーションが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

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

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

このフックには、設定やコンテキストなど、device-code-activation-allowed 画面に固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

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

Example

import { useTenant } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

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

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function UserProfile() {
  const user = useUser();
}

useDeviceCodeActivationAllowed · DeviceCodeActivationAllowedMembers

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

​

共通/ユーティリティ フック

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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