パスワードリセット画面クラス

ACULのパスワードリセット画面クラスについて説明します

​

パスワードリセット画面クラス

パスワードリセット画面クラスはIdentifier First認証フローの一部で、ユーザーのパスワードをリセットします。

パスワードリセット画面クラスのインポートとインスタンス化

import ResetPassword from '@auth0/auth0-acul-js/reset-password';
const resetPasswordManager = new ResetPassword();

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

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

​

プロパティ

パスワードリセット画面クラスには以下のプロパティがあります。

branding

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>;
  };
}

​

メソッド

パスワードリセット画面クラスには以下のメソッドがあります。

​

resetPassword( options? )

パスワードのリセット方法を送信するために、このメソッドはユーザーにメールアドレスを求めます。

import ResetPassword from '@auth0/auth0-acul-js/reset-password';

const resetPassword = new ResetPassword();
resetPassword.resetPassword({
   'password-reset': 'Test@123!',
   're-enter-password': 'Test@123!',
});

Parameter	Type	Required	Description
password	文字列	必須	ユーザーのパスワードです。
re-enter-password	文字列	必須	ユーザーのパスワードです。
[key: string]	文字列 | 数値 | ブール値 | 未定義	任意	ユーザーから収集した追加のデータです。

​

パスワードリセットメール画面クラス

パスワードリセットメール画面クラスはIdentifier First認証フローの一部で、ユーザーにパスワードをリセットする手順を送信します。

パスワードリセットメール画面クラスのインポートとインスタンス化

import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email';
const resetPasswordEmailManager = new ResetPasswordEmail();

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

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

​

プロパティ

パスワードリセットメール画面クラスには以下のプロパティがあります。

branding

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>;
  };
}

​

メソッド

パスワードリセットメール画面クラスには以下のメソッドがあります。

​

resendEmail( options? )

このメソッドはユーザーにパスワードをリセットする手順を再度送信します。

import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email';

const resetPasswordEmail = new ResetPasswordEmail();
resetPasswordEmail.resendEmail();

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

​

パスワードリセットエラー画面クラス

パスワードリセットエラー画面クラスはIdentifier First認証フローの一部で、ユーザーをアプリケーションに戻します。

パスワードリセットエラー画面クラスのインポートとインスタンス化

import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error';
const resetPasswordErrorManager = new ResetPasswordError();

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

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

​

プロパティ

パスワードリセットエラー画面クラスには以下のプロパティがあります。

branding

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>;
  };
}

​

パスワードリセット要求画面クラス

パスワードリセット要求画面クラスはIdentifier First認証フローの一部で、パスワードのリセット方法をメールで送信するために、ユーザーにメールアドレスを求めます。

パスワードリセット要求画面クラスのインポートとインスタンス化

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();

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

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

​

プロパティ

パスワードリセット要求画面クラスには以下のプロパティがあります。

branding

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>;
  };
}

​

メソッド

パスワードリセット要求画面クラスには以下のメソッドがあります。

​

backToLogin( options? )

このメソッドはログインのためにユーザーをアプリケーションに戻します。

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.backToLogin();

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

​

resetPassword( options? )

このメソッドはユーザーにパスワードのリセット方法を受け取るメールアドレスまたはユーザー名の入力を求めます。

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.resetPassword({ username: 'testuser' });

パラメーター	タイプ	必須	説明
captcha	文字列	条件付き	CAPTCHAプロバイダーが返すCAPTCHAコードまたは応答です。このプロパティはAuth0テナントにボット検知が有効化されている場合には必須です。
email	文字列	条件付き	ユーザーのメールです。
[key: string]	文字列 | 数値 | ブール値 | undefined	任意	ユーザーから収集した追加のデータです。

​

パスワードリセット成功画面クラス

パスワードリセット成功画面クラスはIdentifier First認証フローの一部で、パスワードの変更を確認し、ユーザーをアプリケーションに戻します。

パスワードリセット成功画面クラスのインポートとインスタンス化

import ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success';
const resetPasswordSuccessManager = new ResetPasswordSuccess();

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

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

​

プロパティ

パスワードリセット成功画面クラスには以下のプロパティがあります。

branding

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>;
  };
}