A newer version of this documentation is available.

View Latest

addNewWebAuthnDevice

client.addNewWebAuthnDevice(
    authToken,
    origin,
    failure,
    activity,
    // Optional arguments
    friendlyName
)

About this command

When authenticated, the user can add a new FIDO2 device. This method will get a FIDO2 pending intent for registration with the options returned by the ReachFive server and launch it.

The result will be processed by the onAddNewWebAuthnDeviceResult method.

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

Examples

import com.reach5.identity.sdk.core.models.AuthToken

val WEBAUTHN_REGISTER_REQUEST_CODE = 1

val authToken: AuthToken = // The authentication token obtained following signup or login.

client.addNewWebAuthnDevice(
    authToken = authToken,
    origin = "https://dev-sandbox-268508.web.app",
    friendlyName = "Nexus 5"
    registerRequestCode = WEBAUTHN_REGISTER_REQUEST_CODE,
    failure = { error -> ... } // Handle a ReachFive error
)

Parameters

activity Activity

The Android activity.

authToken AuthToken

Authorization token of the profile retrieved from login.

idToken string

The ID token JSON Web Token (JWT) that contains the profile’s information.

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API.

refreshToken string

The refresh token JSON Web Token (JWT) used to obtain new access tokens once they expire.

tokenType string

The type of token. Always equal to Bearer.

expiresIn number

The lifetime in seconds of the access token.

If expiresIn is less than or equal to 0, the AuthToken is expired.

user OpenIdUser

The user’s information contained in the ID token.

failure function

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

friendlyName string

The name of the FIDO2 device. Each device must have a unique name.

Default to the name of the Android product.

originWebAuthn string

The domain of the origin.

Response

Type: Unit

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
  • 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.