addNewWebAuthnDevice

client.addNewWebAuthnDevice(
    authToken,
    origin,
    registerRequestCode,
    failure,
    // 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 profileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login

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

Options

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.

registerRequestCode int

Identifies the return result of the FIDO2 registration when the result arrives.

Response

Type: Unit

ReachFiveError

message string

The message of the error.

code string

The HTTP 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:
  • de - Deutsch

  • en - English

  • es - Español

  • fr - Français

  • it - Italiano

  • nl - Nederlands

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

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.

Feedback