resetPasskeys

AppDelegate.reachfive().resetPasskeys(
    withRequest
)

Description

Resets the passkey for a user. This method is the end of the flow for Account recovery.

Examples

do {
    try await AppDelegate.reachfive().resetPasskeys(withRequest: ResetPasskeyRequest(verificationCode: verificationCode, friendlyName: friendlyName, anchor: window, email: email))
    // handle success
} catch {
    // return ReachFive error on failure
}

Parameters

Parameter Description

withRequest ResetPasskeyRequest

Object containing parameters to send along with the request to reset a passkey.

Object parameters:

  • email: The user’s email.

  • phoneNumber: The user’s phone number.

  • verificationCode: The verification code that confirms the user.

  • originWebAuthn: The origin of the webauthn call.

  • origin: The origin of the call.

  • friendlyName: The name that will be displayed by the system when presenting the passkey for login

  • anchor: The view that the credential provider uses if it requires user interaction.

Response

Error: ReachFiveError

ReachFiveError

Based on the problem, the ReachFiveError will be:

  • AuthCanceled: The user cancelled the request or no credential was available in the keychain.

  • RequestError(apiError: ApiError) for a Bad Request (status 400) error.

  • AuthFailure(reason: String, apiError: ApiError?) mainly for Unauthorized (status 401) error.

  • TechnicalError(reason: String, apiError: ApiError?) if it’s an Internal Server Error (status 500) or other internal errors.

ApiError

error string

The main error message.

errorId string

The identifier of the error.

errorUserMsg string

The user-friendly error message.

This property is translated according to the user’s OS and app settings. Currently supported languages:
Currently supported languages

  • ar - العربية Arabic

  • de - Deutsch German

  • en - English

  • es - Español Spanish

  • fr - Français French

  • hu - Magyar Hungarian

  • it - Italiano Italian

  • jp - 日本 Japanese

  • ko - 한국인 Korean

  • nl - Nederlands Dutch

  • pt - Portuguese

  • ru - Ру́сский Russian

  • sk - Slovenský Slovak

  • zh-CN - People’s Republic of China Simplified Chinese

  • zh-Hans - Simplified Chinese

  • zh-Hant - Traditional Chinese

  • zh-HK - Hong Kong Traditional Chinese

  • zh-MO - Macao Traditional Chinese

  • zh-SG - Singapore Simplified Chinese

  • zh-TW - Taiwan Traditional Chinese

errorMessageKey string

The error message key.

errorDescription string

The technical error message.

errorDetails FieldError[]

field string

The field concerned by the error.

message string

The message error returned for the field.

code string

The code error returned for the field.