LoginPassword - Auth0 Docs

Import Example

import React, { useState } from "react";
import { useScreen, useTransaction, login, useErrors } from "@auth0/auth0-acul-react/login-password";
import { Logo } from "../../components/Logo";

コンテキストフック

useBranding

() => BrandingMembers

ブランディングおよびテーマの設定にアクセスするためのフックです。

Example

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

useClient

() => ClientMembers

Auth0 アプリケーション（クライアント）の設定にアクセスするためのフックです。

Example

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

useOrganization

() => OrganizationMembers

組織コンテキストと設定にアクセスするためのフックです。

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-id';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストがありません</p>;
  }
}

usePrompt

() => PromptMembers

プロンプトおよびフローの設定にアクセスするためのフックです。

Example

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

useScreen

() => ScreenMembersOnLoginPassword

現在の画面情報とメタデータにアクセスするためのフックです。現在の画面名、設定、および画面固有のデータを含む画面オブジェクトです。

Example

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

useTenant

() => TenantMembers

テナントの構成および設定にアクセスするためのフックです。

Example

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

useTransaction

() => TransactionMembersOnLoginPassword

トランザクションの state と認証フローのデータにアクセスするためのフックです。フローの state、セッションデータ、およびトランザクション固有の情報を含むトランザクションオブジェクトです。

Example

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

useUntrustedData

() => UntrustedDataMembers

URL パラメーターおよびフォーム送信からの信頼できないデータにアクセスするためのフックです。

Example

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

useUser

() => UserMembers

ユーザー情報およびプロファイルデータにアクセスするためのフックです。

Example

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

メソッド

表示パラメーター

payload

FederatedLoginPasswordOptions

プロパティ

connection

string

表示パラメーター

payload

LoginPasswordOptions

プロパティ

captcha?

string

password

string

username

string

表示パラメータ

プロパティ

branding

BrandingMembers

プロパティ

settings

BrandingSettings

themes

BrandingThemes

BrandingSettings

export interface BrandingSettings {
  colors?: {
    primary?: string;
    pageBackground?:
      | string
      | {
          type: string;
          start: string;
          end: string;
          angleDegree: number;
        };
  };
  faviconUrl?: string;
  logoUrl?: string;
  fontUrl?: string;
}

プロパティ

colors?

object

表示プロパティ

pageBackground?

string | { angleDegree: number; end: string; start: string; type: string; }

primary?

string

faviconUrl?

string

fontUrl?

string

logoUrl?

string

BrandingThemes

export interface BrandingThemes {
  default: {
    borders: Record<string, string | boolean | number>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

プロパティ

default

object

表示プロパティ

borders

Record<string, string | boolean | number>

colors

Record<string, string>

displayName

string

fonts

Record<string, string | boolean | object>

pageBackground

Record<string, string>

client

ClientMembers

プロパティ

description

string

logoUrl

string

metadata

{[key: string]: string; }

name

string

organization

OrganizationMembers

プロパティ

branding

Branding

displayName

string

metadata

{[key: string]: string; }

name

string

usage

string

prompt

PromptMembers

プロパティ

name

string

screen

ScreenMembersOnLoginPassword

プロパティ

captcha

CaptchaContext

captchaImage

string

captchaProvider

string

captchaSiteKey

string

data

username

editIdentifierLink

string

isCaptchaAvailable

boolean

links

Record

name

string

resetPasswordLink

string

texts

Record

tenant

TenantMembers

プロパティ

enabledFactors

string[]

enabledLocales

string[]

friendlyName

string

name

string

transaction

TransactionMembersOnLoginPassword

プロパティ

alternateConnections

Connection

connectionStrategy

string

countryCode

string

countryPrefix

string

currentConnection

Connection

errors

Error

hasErrors

boolean

isForgotPasswordEnabled

boolean

isPasskeyEnabled

boolean

locale

string

state

string

メソッド

getAllowedIdentifiers

getPasswordPolicy

getUsernamePolicy

untrustedData

プロパティ

authorizationParams

{ [key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; }

submittedFormData

{[key: string]: string | number | boolean | null | undefined; }

user

UserMembers

プロパティ

appMetadata

{[key: string]: string; }

string

enrolledDevices

EnrolledDevice

enrolledEmails

EnrolledEmail

enrolledFactors

string[]

enrolledPhoneNumbers

EnrolledPhoneNumber

string

organizations

Organizations

phoneNumber

string

picture

string

userMetadata

{[key: string]: string; }

username

string

メソッド

表示パラメーター

payload

FederatedLoginPasswordOptions

プロパティ

connection

string

表示パラメーター

ペイロード

LoginPasswordOptions

プロパティ

captcha?

string

password

string

username

string

共通／ユーティリティ用フック

Hooks

Hooks

Hooks

Types

Types

Types

Types

auth0-acul-js

auth0-acul-react

​コンテキストフック

​メソッド

​BrandingSettings

​プロパティ

​BrandingThemes

​プロパティ

​メソッド

​共通／ユーティリティ用フック

コンテキストフック

メソッド

BrandingSettings

プロパティ

BrandingThemes

プロパティ

メソッド

共通／ユーティリティ用フック