mfaStart(WithStepUp)

AppDelegate.reachfive().mfaStart(
    stepUp
)

About this command

Retrieves the stepup token needed for the MFA flow.

The presence of an active session cookie is required. It is automatically retrieved by the function.

Examples

import Reach5

let scope = ["openid", "email", "profile", "phone", "full_write", "offline_access"]

AppDelegate.reachfive()
  .mfaStart(stepUp(
        authType: "email",
        scope: scope,
        authToken: profileAuthToken))
  .onSuccess { _ in
      // Do something
  }
  .onFailure { error in
      // Return a ReachFive error
  }

Parameters

stepUp

Contains the necessary fields to begin the step up process.

This includes the following:

  • authType: The authorization type. This is email or sms.

  • authToken: The authorization token.

  • scope: The defined scope such as openid, email, or phone_number.

  • redirectUri: The URL to which the user is redirected. This URL must be whitelisted in the Allowed Callback URLs field of your ReachFive client settings.

  • tkn: The one-time use authentication token.

  • origin: The domain of the origin. It must be a valid URL.

You should only use one of authToken or tkn.

...
AppDelegate.reachfive()
  .mfaStart(stepUp(
        authType: "email",
        scope: scope,
        authToken: profileAuthToken))
...

Response

Future<ContinueStepUp, ReachFiveError>

ContinueStepUp contains the challengeId.

Error response

ReachFiveError

Based on the problem, the ReachFiveError will be:

  • AuthCanceled: The user cancelled the request or no credential was available in the keychain.

  • 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.

DELETE Maybe saying the ContinueStepUp has a challengeId