listMfaCredentials

client.listMfaCredentials(
  authToken,
  success,
  failure
)

About this command

Lists any registered MFA credentials for a user.

Examples

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

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

client.listMfaCredentials(
    authToken = authToken,
    success = { _ -> ... }, // Do something
    failure = { error -> ... } // Handle a ReachFive error
)

Parameters

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.

amr string[]

Authentication Methods Reference. It indicates the method(s) used during the authentication process

refreshToken string

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

stepUpToken string

The step up token used to continue the step up flow and validate the user for authentication purposes.

This only applies for MFA flows.

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.

success function

Callback called once the request has succeeded.

Response

Type: Promise<MfaCredentialsResponse>

credentials array

An array of objects, each containing information on a specific credential.

    type CredentialType

Specifies the type of credential.

  • sms

  • email

    createdAt string

The date on which the credential was created.

Format

"YYYY-MM-DD"

    friendlyName string

The user-friendly name for the credential.

    phone_number string

The user’s phone number.
Example
{
    credentials: [{
        type: "sms",
        createdAt: "2024-11-15"
    }]
}

Error response

Type: Unit

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.