updatePassword

client.updatePassword(udpatePasswordRequest, successWithNoContent, failure)

About this command

Update the profile’s password. The parameters required in addition to the new password are either:

A fresh access token (less than 5 minutes old).
An access token and the old password.
The profile’s email address/phone number and the verification code sent by email/SMS through a request password reset flow.

The profile must have been granted the full_write scope at the last authentication.

Examples

With an AT
With a fresh AT
With an email
With a phone number

import com.reach5.identity.sdk.core.models.AuthToken
import com.reach5.identity.sdk.core.models.requests.UpdatePasswordRequest.*

val profileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login

client.updatePassword(
  updatePasswordRequest = UpdatePasswordRequest.AccessTokenParams(profileAuthToken, "gVc7piBn", "ZPf7LFtc"),
  successWithNoContent = { _ -> ... }, // Do something
  failure = { error -> ... } // Return a ReachFive error
)

import com.reach5.identity.sdk.core.models.AuthToken
import com.reach5.identity.sdk.core.models.requests.UpdatePasswordRequest.*

val freshProfileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login (less than 5 min)

client.updatePassword(
  updatePasswordRequest = UpdatePasswordRequest.FreshAccessTokenParams(freshProfileAuthToken, "ZPf7LFtc"),
  successWithNoContent = { _ -> ... }, // Do something
  failure = { error -> ... } // Return a ReachFive error
)

import com.reach5.identity.sdk.core.models.requests.UpdatePasswordRequest.*

client.updatePassword(
  updatePasswordRequest = UpdatePasswordRequest.EmailParams("john.doe@example.com", "234", "ZPf7LFtc"),
  successWithNoContent = { _ -> ... }, // Do something
  failure = { error -> ... } // Return a ReachFive error
)

import com.reach5.identity.sdk.core.models.requests.UpdatePasswordRequest.*

client.updatePassword(
  updatePasswordRequest = UpdatePasswordRequest.SmsParams("+33682234940", "234", "ZPf7LFtc"),
  successWithNoContent = { _ -> ... }, // Do something
  failure = { error -> ... } // Return a ReachFive error
)

Parameters

udpatePasswordRequest UdpatePasswordRequest

The parameters required to update the profile’s password.

The UpdatePasswordRequest enum class consists into:

FreshAccessTokenParams
AccessTokenParams
EmailParams
SmsParams

successWithNoContent function

Callback called once the request has succeeded. No argument is expected.

failure function

Callback called once the request has failed. You’ll get a ReachFiveError as an argument.

FreshAccessTokenParams

AuthToken

Authorization token of the profile retrieved from login (less than 5 minutes old).

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.

password string

The new password of the profile. Password must meet the minimum requirements defined by the zxcvbn used. It must also be different from the old one.

AccessTokenParams

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.

oldPassword string

The old password of the profile.

password string

The new password of the profile. Password must meet the minimum requirements defined by the zxcvbn used. It must also be different from the old one.

EmailParams

email string

The email address of the profile.

verificationCode string

The verification code sent by email or SMS.

password string

The new password of the profile. Password must meet the minimum requirements defined by the zxcvbn used. It must also be different from the old one.

SmsParams

phoneNumber string

The phone number of the profile.

Both the international format and the national conventions of the account’s country are accepted if configured in account settings.

verificationCode string

The verification code sent by email or SMS.

password string

The new password of the profile. Password must meet the minimum requirements defined by the zxcvbn used. It must also be different from the old one.

Response

Type: Unit

ReachFiveError

message string

The message of the error.

code string

The HTTP status code.

Redirection errors

The errors listed here are specific to redirection activity for the ReachFive Android SDK.

0 = Success!
-1 = Unexpected result. Contact support.
1 = Request aborted.
2 = Unauthorized request.

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.