サインアップス画面クラス

サインアップス画面クラスはIdentifier First認証フローの一部で、ユーザの識別子を収集します。テナントのセットアップに応じて、この識別子はメールアドレス、電話番号、またはユーザー名になります。

サインアップ画面クラスのインポートとインスタンス化

import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();

// SDK Properties return a string, number or boolean
// ex. "login-id"
signupManager.screen.name;

// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"} 
signupManager.screenLinks();

プロパティ

サインアップ画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
 captcha: null | CaptchaContext;
 captchaImage: null | string;
 captchaProvider: null | string;
 captchaSiteKey: null | string;
 data: null | {
   loginLink?: string;
   name?: string;
 };
 isCaptchaAvailable: boolean;
 links: null | Record<string, string>;
 name: string;
 texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface TransactionMembersOnSignup {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];
  hasErrors: boolean;
  isPasskeyEnabled: boolean;
  locale: string;
  optionalIdentifiers: null | ("email" | "username" | "phone")[];
  requiredIdentifiers: null | ("email" | "username" | "phone")[];
  state: string;
  usernamePolicy: null | UsernamePolicy;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface UsernamePolicy {
  allowedFormats: {
    usernameInEmailFormat: boolean;
    usernameInPhoneFormat: boolean;
  };
  maxLength: number;
  minLength: number;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

サインアップ画面クラスには以下のメソッドがあります。

pickCountryCode( options? )

このメソッドはユーザーを国番号選択リストにリダイレクトし、ユーザーが電話番号の国番号を更新できるようにします。

import Signup from "@auth0/auth0-acul-js/signup";
const signupManager = new Signup();

signupManager.pickCountryCode();

このメソッドはユーザーを認証フローの次のステップにリダイレクトします。サーバーの構成に応じて、この画面にはメールアドレス、ユーザー名、電話番号の中から1つ以上が含まれます。詳細については、「柔軟な識別子」を参照してください。

import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: 'test@example.com',
 password: 'P@$$wOrd123!',
});

パラメーター	タイプ	必須	説明
`email`	文字列	条件付き	ユーザーのメールです。
`phone`	文字列	条件付き	ユーザーの電話番号です。
`username`	文字列	条件付き	ユーザーのユーザー名です。
`password`	文字列	条件付き	ユーザーのパスワードです。
`captcha`	文字列	条件付き	CAPTCHAプロバイダーが返すCAPTCHAコードまたは応答です。このプロパティはAuth0テナントにボット検知が有効な場合には必須です。
`[key: string]`	文字列 \| 数値 \| ブール値 \| undefined	任意	ユーザーから収集した追加のデータです。このデータには`pre-user-registration`アクショントリガーでアクセスできます。

socialSignup( options? )

このメソッドは認証のために、ユーザーをソーシャルまたはエンタープライズIDプロバイダー（）にリダイレクトします。詳細については、「ソーシャルIDプロバイダー」と「エンタープライズIDプロバイダー」を参照してください。

import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.federatedSignup({
 connection: 'google-oauth2'
});

パラメーター	タイプ	必須か否か	説明
`connection`	文字列	必須	接続の識別子。
`[key: string]`	文字列 \| 番号 \| ブール値 \| 未定義	任意	ユーザーから収集した追加のデータ。

サインアップID画面クラス

サインアップID画面クラスはIdentifier First認証フローの一部で、ユーザの識別子を収集します。テナントのセットアップに応じて、この識別子はメールアドレス、電話番号、またはユーザー名になります。

サインアップID画面クラスのインポートとインスタンス化

import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();

// SDK Properties return a string, number or boolean
// ex. "signup-id"
signupIdManager.screen.name;

// SDK Methods return an object or array
// ex. { login: "/login_url"} 
signupIdManager.screenLinks();

プロパティ

サインアップID画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | Record<string, string>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  loginLink: null | string;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];
  hasErrors: boolean;
  isPasskeyEnabled: boolean;
  locale: string;
  optionalIdentifiers: null | ("email" | "username" | "phone")[];
  requiredIdentifiers: null | ("email" | "username" | "phone")[];
  state: string;
  usernamePolicy: null | UsernamePolicy;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    display_name?: string;
    icon_url?: string;
    show_as_button: boolean;
  };
  strategy: string;
}

interface UsernamePolicy {
  allowedFormats: {
    usernameInEmailFormat: boolean;
    usernameInPhoneFormat: boolean;
  };
  maxLength: number;
  minLength: number;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

サインアップID画面クラスには以下のメソッドがあります。このメソッドはユーザーを認証フローの次のステップに進めます。サーバーの構成に応じて、この画面にはメールアドレス、ユーザー名、電話番号の中から1つ以上が含まれます。詳細については、「柔軟な識別子」を参照してください。

import SignupId from "@auth0/auth0-acul-js/signup-id";

const signupIdManager = new SignupId();
const { transaction } = signupIdManager;

//get mandatory & optional identifiers required for signup
const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email
const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone

const signupParams = {
 email : "testEmail",
 phone : "+91923456789"
};

signupIdManager.signup(signupParams);

パラメーター	タイプ	必須	説明
`email`	文字列	条件付き	ユーザーのメールです。
`phone`	文字列	条件付き	ユーザーの電話番号です。
`username`	文字列	条件付き	ユーザーのユーザー名です。
`captcha`	文字列	条件付き	CAPTCHAプロバイダーが返すCAPTCHAコードまたは応答です。このプロパティはAuth0テナントにボット検知が有効な場合には必須です。
`[key: string]`	文字列 \| 数値 \| ブール値 \| 未定義	任意	ユーザーから収集した追加のデータです。このデータには`pre-user-registration`アクショントリガーでアクセスできます。

socialSignup( options? )

このメソッドは認証のために、ユーザーをソーシャルまたはエンタープライズIDプロバイダー（IdP）にリダイレクトします。詳細については、「ソーシャルIDプロバイダー」と「エンタープライズIDプロバイダー」を参照してください。

import SignupId from "@auth0/auth0-acul-js/signup-id";

const signupIdManager = new SignupId();
const { transaction } = signupIdManager;

//get social connections
const socialConnection = transaction.getAlternateConnections(); //eg: "google-oauth2"

const signupParams = {
 connection : socialConnection[0].name, // "google-oauth2"
};

signupIdManager.federatedSignup(signupParams);

パラメーター	タイプ	必須か否か	説明
`connection`	文字列	必須	接続の識別子。
`[key: string]`	文字列 \| 番号 \| ブール値 \| 未定義	任意	ユーザーから収集した追加のデータ。

サインアップパスワード画面クラス

サインアップパスワード画面クラスはIdentifier First認証フローの一部で、ユーザーが自分のプロファイルにパスワードを作成できるようにします。

サインアップパスワード画面クラスのインポートとインスタンス化

import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();

// SDK Properties return a string, number or boolean
// ex. "signup-password"
signupPasswordManager.screen.name;

// SDK Methods return an object or array
// ex. { login: "/login_url", edit_identifier: "/edit_url"} 
signupPasswordManager.screenLinks();

プロパティ

サインアップパスワード画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    email?: string;
    phone?: string;
    username?: string;
  };
  editLink: null | string;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  loginLink: null | string;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];
  hasErrors: boolean;
  isPasskeyEnabled: boolean;
  locale: string;
  optionalIdentifiers: null | ("email" | "username" | "phone")[];
  passwordPolicy: null | PasswordPolicy;
  requiredIdentifiers: null | ("email" | "username" | "phone")[];
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    display_name?: string;
    icon_url?: string;
    show_as_button: boolean;
  };
  strategy: string;
}

interface PasswordPolicy {
    minLength?: number;
    policy:
        | "low"
        | "fair"
        | "good"
        | "excellent";
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

サインアップパスワード画面クラスには以下のメソッドがあります。ユーザーのアカウントを作成するために、このメソッドは前のステップからの識別子と入力されたパスワードを送信します。作成されると、ユーザーは次のステップに誘導されます。

signupPasswordManager.signup({
  email: <EmailFieldValue>
  phone: <PhoneFieldValue>
  username: <UsernameFieldValue>
  password: ****** **
});

パラメーター	タイプ	必須	説明
`captcha`	文字列	条件付き	CAPTCHAプロバイダーが返すCAPTCHAコードまたは応答です。このプロパティはAuth0テナントにボット検知が有効な場合には必須です。
`email`	文字列	条件付き	ユーザーのメールです。
`password`	文字列	必須	ユーザーのパスワードです。
`phone`	文字列	条件付き	ユーザーの電話番号です。
`username`	文字列	条件付き	ユーザーのユーザー名です。
`[key: string]`	文字列 \| 数値 \| ブール値 \| 未定義	任意	ユーザーから収集した追加のデータです。このデータには`pre-user-registration`アクショントリガーでアクセスできます。

パスキー登録画面クラス

パスキー登録画面クラスはIdentifier First認証フローの一部です。ユーザーがパスキーを作成して、次回からアプリケーションで認証するときに自分の資格情報として使用できるようにします。Auth0でのパスキー使用については、「パスキー」を参照してください。

パスキー登録画面クラスのインポートとインスタンス化

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passskeyEnrollmentManager = new PasskeyEnrollment();

// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment"
passskeyEnrollmentManager.screen.name;

// SDK Methods return an object or array
// ex. { back: "/back_url" } 
passskeyEnrollmentManager.screenLinks();

プロパティ

パスキー登録画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  backLink: null | string;
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | Record<string, string>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  loginLink: null | string;
  name: string;
  publicKey: null | {
    authenticatorSelection: {
      residentKey: string;
      userVerification: string;
    };
    challenge: string;
    pubKeyCredParams: [{
      alg: number;
      type: string;
    }];
    rp: {
      id: string;
      name: string;
    };
    user: {
      displayName: string;
      id: string;
      name: string;
    };
  };
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

パスキー登録画面クラスには以下のメソッドがあります。

abortPasskeyEnrollment( options? )

このメソッドはパスワードを作成するために、ユーザーをサインアップパスワード画面に誘導します。

// This method does not support any parameters
passkeyEnrollment.abortPasskeyEnrollment();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

continuePasskeyEnrollment( options? )

パスキーを作成して、ユーザーを認証します。パスキーを作成したら、このメソッドがユーザーをredirect_urlにリダイレクトします。

// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

パスキー登録ローカル画面クラス

パスキー登録ローカル画面クラスはIdentifier First認証フローの一部です。ユーザーがパスキーを作成して、次回からアプリケーションで認証するときに自分の資格情報として使用できるようにします。Auth0でのパスキー使用については、「パスキー」を参照してください。

パスキー登録ローカル画面クラスのインポートとインスタンス化

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passskeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();

// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment-local"
passskeyEnrollmentLocalManager.screen.name;

// SDK Methods return an object or array
// ex. { back: "/back_url" } 
passskeyEnrollmentLocalManager.screenLinks();

プロパティ

パスキー登録ローカル画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | Record<string, string>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  publicKey: null | {
    authenticatorSelection: {
      residentKey: string;
      userVerification: string;
    };
    challenge: string;
    pubKeyCredParams: [{
      alg: number;
      type: string;
    }];
    rp: {
      id: string;
      name: string;
    };
    user: {
      displayName: string;
      id: string;
      name: string;
    };
  };
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

パスキー登録ローカル画面クラスには以下のメソッドがあります。

abortPasskeyEnrollment( options )

パスキーの作成をスキップし、代わりにパスワードを提供します。このメソッドはパスワードを作成するために、ユーザーをサインアップパスワード画面に誘導します。

passkeyEnrollment.abortPasskeyEnrollment({
  doNotShowAgain: <BooleanFieldValue>
});

パラメーター	タイプ	必須か否か	説明
`doNotShowAgain`	ブール値	必須	初期作成をスキップした後、パスキーを再度作成するよう促す通知をユーザーに表示するかどうかを指定します。

continuePasskeyEnrollment( options? )

パスキーを作成して、ユーザーを認証します。パスキーを作成したら、この操作がユーザーをredirect_urlにリダイレクトします。

// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

電話識別子チャレンジ画面クラス

電話識別子チャレンジ画面クラスはIdentifier First認証フローの一部で、ユーザーがサインアップする前にユーザーの電話番号を検証します。詳細については、「柔軟な識別子の属性をアクティブ化して構成する」を参照してください。

電話識別子チャレンジ画面クラスのインポートとインスタンス化

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();

// SDK Properties return a string, number or boolean
// ex. "phone-identifier-challenge"
phoneIdentifierChallengeManager.screen.name;

// SDK Methods return an object or array
// ex. data: { message_type: "text", phone: "+1234567890" };
phoneIdentifierChallengeManager.screenData();

プロパティ

電話識別子チャレンジ画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    messageType?: "text" | "voice";
    phone?: string;
  };
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

電話識別子チャレンジ画面クラスには以下のメソッドがあります。

resendCode( options? )

このメソッドは前のステップで入力されたメールアドレスに新しいOTPコードを送信します。

// This method does not support any parameters
phoneIdentifierChallenge.resendCode();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

returnToPrevious( options? )

このメソッドはユーザーを前のステップに戻します。

// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

submitPhoneChallenge( options )

このメソッドは入力された電話番号を検証し、ユーザーがサインアップを続行できるようにします。

phoneIdentifierChallenge.submitPhoneChallenge({
    code: "<CodeFieldValue>"
});

パラメーター	タイプ	必須か否か	説明
`captcha`	文字列	条件付き	captchaコードまたはcaptchaプロバイダーからの応答。このプロパティは、Auth0テナントでボット検知が有効になっている場合に必要です。
`code`	文字列	必須	電話番号に送信されるOTPコード。
`[key: string]`	文字列 \| 番号 \| ブール値 \| 未定義	任意	ユーザーから収集した任意のデータ。

電話識別子登録画面クラス

電話識別子登録画面クラスはIdentifier First認証フローの一部で、サインアップのプロセスを続ける前に、ユーザーが電話番号の検証手段を選択できるようにします。詳細については、「柔軟な識別子の属性をアクティブ化して構成する」を参照してください。

電話識別子登録画面クラスのインポートとインスタンス化

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();

// SDK Properties return a string, number or boolean
// ex. "phone-identifier-enrollment"
phoneIdentifierEnrollmentManager.screen.name;

// SDK Methods return an object or array
// ex. { phone_number: "+1234567890" } 
phoneIdentifierEnrollmentManager.screenData();

プロパティ

電話識別子登録画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    messageType?: "text" | "voice";
    phone?: "string";
  };
  editIdentifierLink: null | string;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

電話識別子登録画面クラスには以下のメソッドがあります。

continuePhoneEnrollment( options )

ユーザーが選択した手段を使って、前のステップで入力した電話番号にOTPコードを送信します。

phoneIdentifierChallenge.continuePhoneEnrollment({
  type: "text" | "voice"
});

パラメーター	タイプ	必須	説明
`type`	文字列	はい	可能な値：`text`または`voice`
`[key: string]`	文字列 \| 数値 \| ブール値 \| undefined	いいえ	ユーザーから収集される任意のデータ。

returnToPrevious( options? )

このメソッドはユーザーを前のステップに戻します。

// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

メール識別子チャレンジ画面クラス

メール識別子チャレンジ画面クラスはIdentifier First認証フローの一部で、ユーザーがサインアップする前に、ユーザーのメールアドレスを検証します。詳細については、「柔軟な識別子の属性をアクティブ化して構成する」を参照してください。

メール識別子チャレンジ画面クラスのインポートとインスタンス化

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();

// SDK Properties return a string, number or boolean
// ex. "email-identifier-challenge"
emailIdentifierChallengeManager.screen.name;

// SDK Methods return an object or array
// ex. { email: "someone@example.com" } 
emailIdentifierChallengeManager.screenData();

プロパティ

メール識別子チャレンジ画面クラスには以下のプロパティがあります。

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

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

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen{
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    email?: string;
    messageType?: string;
  };
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

メソッド

メール識別子チャレンジ画面クラスには以下のメソッドがあります。

resendCode( options? )

このメソッドは前のステップで入力されたメールアドレスに新しいOTPコードを送信します。

// This method does not support any parameters
emailIdentifierChallenge.resendCode();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

returnToPrevious( options? )

このメソッドはユーザーを前のステップに戻します。

// This method does not support any parameters
emailIdentifierChallenge.returnToPrevious();

パラメーター	タイプ	必須	説明
`[key: string]`	文字列 \| 数字 \| ブール値 \| undefined	任意	ユーザーから収集した任意のデータです。

submitEmailChallenge( options? )

このメソッドは入力されたメールアドレスを検証し、ユーザーがサインアップを続行できるようにします。

emailIdentifierChallenge.submitEmailChallenge({
  code: <CodeFieldValue>
});

パラメーター	タイプ	必須か否か	説明
`captcha`	文字列	条件付き	captchaコードまたはcaptchaプロバイダーからの応答。このプロパティは、Auth0テナントでボット検知が有効になっている場合に必要です。
`code`	文字列	必須	メールアドレスに送信されるOTPコード。
`[key: string]`	文字列 \| 番号 \| ブール値 \| 未定義	任意	ユーザーから収集した追加のデータ。

ブランドのカスタマイズ

コードのカスタマイズ

サードパーティーのカスタマイズ

Documentation Index