mfaListCredentials

AppDelegate.reachfive().mfaListCredentials(authToken)

About this command

Lists a user’s MFA credentials. These credentials are those verified for use as a second factor during the MFA process.

Examples

import Reach5

do {
    let credentials = try await AppDelegate.reachfive().mfaListCredentials(authToken: profileAuthToken)
    // Do something
} catch {
    // Return 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.

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.

Response

Type: MfaCredentialsListResponse
Error: ReachFiveError

MfaCredentialsListResponse

Email
Phone number

credentials: [
    {"createdAt": "createdAtDate", "friendlyName": "friendlyName", "email": "joe@example.com", "type": CredentialType}
] (1)

1	Contains array of `MfaCredentialItem` objects.

credentials: [
    {"createdAt": "createdAtDate", "friendlyName": "friendlyName", "phoneNumber": "+35312345678", "type": CredentialType}
] (1)

1	Contains array of `MfaCredentialItem` objects.

credentials

friendlyName string

The name that is displayed by the system for the MFA credential item.

createdAt string

The time when the MFA credential item was created.

phoneNumber string

The phone number for the MFA credential.

This is only applicable for the type sms.

email string

The email for the MFA credential.

This is only applicable for the type email.

type CredentialType

The MFA credential type.

sms
email

Error response

ReachFiveError

Based on the problem, the ReachFiveError will be:

AuthCanceled: Nothing happened, and nothing is expected of you — ignoring it is a valid way to handle it.
This can happen for any of the following reasons:
- The user canceled the request.
- No passkey was saved for your app.
- A web login was dropped because another one was already in progress. See webviewLogin.
- The app is not associated with the host of an WebProvider .universalLink callback. See guides/apple-app-site-association.adoc#webcredentials.
RequestError(apiError: ApiError) for a Bad Request (status 400) error.
AuthFailure(reason: String, apiError: ApiError?) mainly for Unauthorized (status 401) error.
TechnicalError(reason: String, apiError: ApiError?) if it’s an Internal Server Error (status 500) or other internal errors.

ApiError

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 OS and app 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 error message key.

errorDescription string

The technical error message.

errorDetails FieldError[]

field string

The field concerned by the error.

message string

The message error returned for the field.

code string

The code error returned for the field.