listMfaCredentials

client.listMfaCredentials(accessToken: string)

About this command

Lists the user’s MFA credentials.

This is typically the phone number registered to use with MFA.

Examples

client.listMfaCredentials('eyJ0eXAiOiJKV1QiL...')

Parameters

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old.

Response

Type: Promise<MfaCredentialsResponse>

credentials array

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

    type CredentialType

Specifies the type of credential. Values: sms.

    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: "2021-10-25"
    }]
}
Feedback