loginWithWebAuthn

client.loginWithWebAuthn(loginRequest, failure, activity)

About this command

A user with an already registered credential can authenticate with a registered FIDO2 device. This method will get a FIDO2 pending intent for authentication with the options returned by the ReachFive server and launch it.

The result will be processed by the onLoginActivityResult method.

  • The WebAuthn feature must be enabled on your ReachFive account.

Examples

  • With an email

  • With a phone number

import com.reach5.identity.sdk.core.models.requests.webAuthn.WebAuthnLoginRequest

client.loginWithWebAuthn(
    webAuthnLoginRequest = WebAuthnLoginRequest.EmailWebAuthnLoginRequest(
        origin = "https://dev-sandbox-268508.web.app",
        email = "john.doe@example.com",
        scope = setOf("openid", "profile", "email")
    ),
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity
)
import com.reach5.identity.sdk.core.models.requests.webAuthn.WebAuthnLoginRequest

client.loginWithWebAuthn(
    webAuthnLoginRequest = WebAuthnLoginRequest.EmailWebAuthnLoginRequest(
        origin = "https://dev-sandbox-268508.web.app",
        phoneNumber = "+33682234940",
        scope = setOf("openid", "profile", "phone")
    ),
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity
)

Parameters

loginRequest WebAuthnLoginRequest

The parameters required to login with a registered FIDO2 device.

The WebAuthnLoginRequest enum class consists into:

  • EmailWebAuthnLoginRequest

  • PhoneNumberWebAuthnLoginRequest

failure function

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

activity Activity

The Android activity.

EmailWebAuthnLoginRequest

originWebAuthn string

The domain of the origin.

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.

email string

The email address of the profile.

PhoneNumberWebAuthnLoginRequest

originWebAuthn string

The domain of the origin.

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.

phoneNumber string

The phone number of the profile.

Both the international format and the national conventions of the account’s country are accepted if configured in account settings.

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 code from the underlying WebAuthn library.

Code Message Description

9

NOT_SUPPORTED_ERR

The operation is not supported.

11

INVALID_STATE_ERR

The object is in an invalid state.

18

SECURITY_ERR

The operation is insecure.

19

NETWORK_ERR

A network error has occurred.

20

ABORT_ERR

The operation was aborted.

23

TIMEOUT_ERR

The operation timed out.

27

ENCODING_ERR

The encoding operation (either encoded or decoding) failed.

28

UNKNOWN_ERR

The operation failed for an unknown transient reason.

29

CONSTRAINT_ERR

A mutation operation in a transaction failed because a constraint was not satisfied.

30

DATA_ERR

The provided data is inadequate.

35

NOT_ALLOWED_ERR

The request is not allowed by the user agent or the platform in the current context, possibly because the user denied permission to the application/request.

36

ATTESTATION_NOT_PRIVATE_ERR

The authenticator violates the privacy requirements that the AttestationStatementType it is using.

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
  • de - Deutsch German

  • en - English

  • es - Español Spanish

  • fr - Français French

  • hu - Magyar Hungarian

  • it - Italiano Italian

  • nl - Nederlands Dutch

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

  • sk - Slovenský Slovak

  • pt - Portuguese

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.