メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://auth0.generaltranslation.app/llms.txt

Use this file to discover all available pages before exploring further.

MfaWebAuthnPlatformEnrollment
Example
// 'sdk' が MfaWebAuthnPlatformEnrollment のインスタンスであることを前提とする
try {
  await sdk.submitPasskeyCredential(); // publicKey を明示的に渡す必要はない
  // 成功時は Auth0 がリダイレクトを処理する
} catch (error) {
  console.error('パスキーの登録に失敗しました:', error);
  if (error.name && error.message) { // WebAuthn エラーかどうかを確認する
    await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
  }
}

​
コンストラクター

​
MfaWebAuthnPlatformEnrollment
Constructor
MfaWebAuthnPlatformEnrollment クラスの新しいインスタンスを初期化します。

​
例外

Universal Login コンテキストが利用できない場合、またはコンテキスト内の画面名が MfaWebAuthnPlatformEnrollment.screenIdentifier と一致しない場合に例外がスローされます。

​
プロパティ

​
branding
​
client
​
organization
​
prompt
​
screen
​
tenant
​
transaction
​
untrustedData
​
user
​
screenIdentifier
string
static

​
メソッド

​
getErrors
コンテキストからトランザクションエラーの配列を取得します。存在しない場合は空の配列を返します。トランザクションコンテキストに含まれるエラーオブジェクトの配列です。
​
refuseEnrollmentOnThisDevice
Promise<void>
現在のデバイスでの WebAuthn プラットフォーム登録をユーザーが拒否できるようにします。拒否アクションの送信が成功したときに解決される Promise です。
​
reportBrowserError
Promise<void>
WebAuthn の navigator.credentials.create() 操作中に発生したブラウザ側のエラーを報告します。エラーレポートの送信が成功したときに解決される Promise です。

​
送出

フォーム送信に失敗した場合はエラーを送出します。
​
snoozeEnrollment
Promise<void>
ユーザーが WebAuthn プラットフォーム登録を後で行うように延期できるようにします。スヌーズアクションの送信が成功したときに解決される Promise です。
​
submitPasskeyCredential
Promise<void>
this.screen.publicKey で利用可能な公開鍵オプションを使用して WebAuthn プラットフォーム認証情報の作成プロセスを開始し、その結果得られた認証情報をサーバーに送信します。 このメソッドは内部的に createPasskeyCredentials（navigator.credentials.create() をラップしたもの）を呼び出します。認証情報が正常に作成され、送信されたときに解決される Promise です。

​
送出

this.screen.publicKey が利用できない場合、createPasskeyCredentials が失敗した場合 （例: ユーザーによるキャンセル、ハードウェアの問題）、またはサーバーへの送信に失敗した場合にエラーを送出します。
Example
// 'sdk' が MfaWebAuthnPlatformEnrollment のインスタンスであると仮定
try {
  await sdk.submitPasskeyCredential(); // publicKey を明示的に渡す必要はありません
  // 成功時には Auth0 がリダイレクトを処理します。
} catch (error) {
  console.error('Passkey enrollment failed:', error);
  if (error.name && error.message) { // WebAuthn のエラーらしいかどうかを確認
    await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
  }
}