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:
-
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 |
The main error message. |
||||||
errorId |
The identifier of the error. |
||||||
errorUserMsg |
The user-friendly error message.
|
||||||
errorMessageKey |
The error message key. |
||||||
errorDescription |
The technical error message. |
||||||
errorDetails FieldError[] |
|