updatePassword
AppDelegate.reachfive().updatePassword(updatePasswordRequest)
Description
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).
-
The old password.
-
The profile’s email address/phone number and the verification code sent by email/SMS through a request password reset flow.
|
Examples
import Reach5
let profileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login
AppDelegate
.reachfive()
.updatePassword(
.AccessTokenParams(
authToken: profileAuthToken,
oldPassword: "gVc7piBn",
password: "ZPf7LFtc"
)
)
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// Return a ReachFive error
}
import Reach5
let freshProfileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login (less than 5 min)
AppDelegate
.reachfive()
.updatePassword(
.FreshAccessTokenParams(
authToken: freshProfileAuthToken,
password: "ZPf7LFtc"
)
)
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// Return a ReachFive error
}
import Reach5
AppDelegate
.reachfive()
.updatePassword(
.EmailParams(
email: "john.doe@example.com",
verificationCode: "234",
password: "ZPf7LFtc"
)
)
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// Return a ReachFive error
}
import Reach5
AppDelegate
.reachfive()
.updatePassword(
.SmsParams(
phoneNumber: "+33682234940",
verificationCode: "234",
password: "ZPf7LFtc"
)
)
.onSuccess{ _ in
// Do something
}
.onFailure { error in
// Return a ReachFive error
}
Parameters
The UpdatePasswordRequest enum class consists into:
-
FreshAccessTokenParams -
AccessTokenParams -
EmailParams -
SmsParams
FreshAccessTokenParams
| Parameter | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authorization token of the profile retrieved from login (less than 5 minutes old).
|
|||||||||||||
password |
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
| Parameter | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authorization token of the profile retrieved from login.
|
|||||||||||||
The old password of the profile. |
|||||||||||||
password |
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
| Parameter | Description |
|---|---|
The email address of the profile. |
|
The verification code sent by email or SMS. |
|
password |
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
| Parameter | Description |
|---|---|
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. |
|
The verification code sent by email or SMS. |
|
password |
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: Future<(), ReachFiveError>
The profile’s password will be updated. If the parameters are invalid or if the full_write scope is missing, the promise will be rejected and will return a ReachFiveError.
ReachFiveError
Based on the problem, the ReachFiveError will be:
-
RequestError(requestErrors: RequestErrors)if it’s a bad request error.error
stringThe main error message.
errorId
stringThe identifier of the error.
errorUserMsg
stringThe 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
stringThe error message key.
errorDescription
stringThe technical error message.
errorDetails FieldError[]
field
stringThe field concerned by the error.
message
stringThe message error returned for the
field.code
stringThe code error returned for the
field.-
AuthFailure(reason: String)if the authentication has failed. -
AuthCanceledif the authentication was cancelled. -
TechnicalError(reason: String)if it’s an internal server error.