DeviceCodeConfirmation

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

device-code-confirmation 画面は、Device Authorization Flow 中に表示されます。ユーザーに確認用のコードを表示し、デバイス有効化リクエストを承認するか拒否するかを求めます。

​

インポート

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

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを取り込めます。
• ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるあらゆる画面に対応する統一ビルドが必要な場合に便利です。

Import Example

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

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

function DeviceCodeConfirmationScreen() {
  const { confirm, cancel } = useDeviceCodeConfirmation();
  return (
    <>
      <button onClick={() => confirm()}>Confirm</button>
      <button onClick={() => cancel()}>Cancel</button>
    </>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/device-code-confirmation';
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-confirmation';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnDeviceCodeConfirmation

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useDeviceCodeConfirmation · DeviceCodeConfirmationMembers

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

​

メソッド

cancel · Promise<void>

このメソッドは、デバイスコードフローをキャンセルし、アクティベーションリクエストを拒否します。

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function CancelButton() {
  const { cancel } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => cancel()}>
      Cancel
    </button>
  );
}

confirm · Promise<void>

このメソッドは、デバイスコードを確定し、アクティベーションリクエストを承認します。

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function ConfirmButton() {
  const { confirm } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => confirm()}>
      Confirm
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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