DeviceCodeActivation

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

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

​

インポート

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

• partial import を使用すると、特定のユースケースに必要なコードだけを含めることができます。
• root import を使用すると、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>
  );
}

​

コンテキストフック

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

このフックは、デバイスのアクティベーションが組織にスコープされている場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は 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

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

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

このフックは、アクティブな接続や現在のフローの state など、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

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

useErrors · Hooks

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