loginWithPasskey

client.loginWithPasskey(
    loginRequest,
    scope,
    origin,
    success,
    failure,
    activity
)

About this command

A user with an already registered credential can authenticate with a passkey.

The WebAuthn feature must be enabled on your ReachFive account.

Examples

  • With an email

  • With a phone number

client.loginWithPasskey(
    loginRequest = WebAuthnLoginRequest.EmailWebAuthnLoginRequest(
        email = "john.doe@example.com"
    ),
    origin = "passkey login from Android app",
    success = { authToken -> ... }, // Get the profile's authentication token
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity,
)
client.loginWithPasskey(
    loginRequest = WebAuthnLoginRequest.PhoneNumberWebAuthnLoginRequest(
        phoneNumber = "+33682234940",
    ),
    origin = "passkey login from Android app",
    success = { authToken -> ... }, // Get the profile's authentication token
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity,
)

Parameters

activity Activity

The Android activity.

failure function

Callback called once the request has failed. You’ll get a ReachFiveError as an argument.

loginRequest WebAuthnLoginRequest

The parameters required to login with a registered FIDO2 device.

The WebAuthnLoginRequest enum class consists into:

  • EmailWebAuthnLoginRequest

  • PhoneNumberWebAuthnLoginRequest

origin string

Free text parameter describing the source of the login (only for reporting purposes).

scope string[]

List of space-delimited, case-sensitive strings representing the requested scope.

Default scopes are the allowed scopes set up in the client’s configuration.

success function

Callback called once the request has succeeded.

Takes authToken as a parameter.

Response

This method returns Unit. The login result will be obtained through the onLoginActivityResult method.

ReachFiveError

message string

The message of the error.

getErrorCode() ErrorCode

The error code’s enumeration value.

code string

The HTTP status code or SDK error code.

exception string

The stack trace of the error.

data ReachFiveApiError

Additional data about the error.

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 browser 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 technical error code.

errorDescription string

The technical error message.

errorDetails ReachFiveApiErrorDetails

  • field - The field concerned by the error.

  • message - The message error returned for the field.