startStepUp
About this command
Retrieves the stepup token needed for the MFA flow and starts the passwordless flow by sending an email or SMS to the user with a single-use auth code or access token (depending on the response type).
The Passwordless feature must be enabled on your ReachFive Console account. The SMS feature must be enabled on your ReachFive Console account if the profile can choose a phone number to login. |
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.startStepUp(
authToken = authToken,
authType = "sms",
redirectUri = "reachfive-${clientId}://callback",
scope = setOf("openid", "profile", "phone"),
success = { _ -> ... }, // Do something
failure = { error -> ... }, // Handle a ReachFive error
activity = activity,
origin = "https://dev-sandbox-268508.web.app",
)
Parameters
The Android activity. |
|||||||||||||
Authorization token of the profile retrieved from login.
|
|||||||||||||
The type of passwordless authentication. Allowed values:
|
|||||||||||||
Callback called once the request has failed. You’ll get a |
|||||||||||||
Free text parameter describing the source of the login (only for reporting purposes). |
|||||||||||||
The URL where the user will be redirected after the passwordless success. Default value is |
|||||||||||||
List of space-delimited, case-sensitive strings representing the requested scope. Default scopes are the allowed scopes set up in the client’s configuration. |
|||||||||||||
Callback called once the request has succeeded. |
Response
The code challenge ID to verify the user. |
ReachFiveError
message |
The message of the error. |
||||||||||||||
getErrorCode() |
The error code’s enumeration value. |
||||||||||||||
code |
The HTTP status code or SDK error code. |
||||||||||||||
exception |
The stack trace of the error. |
||||||||||||||
data |
Additional data about the error.
|