DeviceCodeActivation

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

device-code-activation 画面は、Device Authorization フロー中に表示されます。この画面では、ユーザーに対して、デバイスを認可するためにそのデバイス上に表示されているデバイスコードの入力を求めます。

​

インポート

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

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

Import Example

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

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

function DeviceCodeActivationScreen() {
  const { continueMethod } = useDeviceCodeActivation();
  return (
    <button onClick={() => continueMethod({ code: 'ABCD-1234' })}>
      Activate Device
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useDeviceCodeActivation · DeviceCodeActivationMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、デバイスの認可のためにユーザーが入力したデバイスコードを送信します。

Example

import { useDeviceCodeActivation } from '@auth0/auth0-acul-react/device-code-activation';

function DeviceCodeForm() {
  const { continueMethod } = useDeviceCodeActivation();
  return (
    <button onClick={() => continueMethod({ code: 'ABCD-1234' })}>
      Activate Device
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

DeviceCodeActivationContinueOptions。

code · string · 必須

デバイスを認可するためにユーザーが入力したデバイスコードです。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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