discoverableLogin

client.discoverableLogin(
    requestCredentialTypes,
    origin,
    scope,
    failure,
    success,
    activity,
    // Optional argument
    captcha
)

About this command

Use this method to discover a credential to log in a user. This can be via password, passkey, or both.

The captcha parameter applies only when the discovered credential is a password. The SDK ignores it when the credential is a passkey.

The WebAuthn feature must be enabled on your ReachFive account.

Examples

client.discoverableLogin(
    origin = "discoverable 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.

origin string

Free text parameter describing the source of the event (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.

requestCredentialTypes enum

Set the type of credentials to request.

Pass like CredentialType.Password, or CredentialType.Passkey. Default is both.

enum class CredentialType {
    Password,
    Passkey
}

success function

Callback called once the request has succeeded.

Takes authToken as a parameter.

captcha CaptchaToken

A captcha token and the provider that issued it.

Pass a ReCaptchaToken or a CaptchaFoxToken.

This parameter is required when the ReachFive Console protects the endpoint with a Captcha. The ReachFive Android SDK forwards the token and does not show a challenge or fetch a token. Get the token from Google reCAPTCHA or CaptchaFox in your app, then pass it here.

Enable Captcha in the ReachFive Console at reCAPTCHA or CaptchaFox.

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.

See Android SDK errors for more details.

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.