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.

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

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 IdentitySdkCore

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 IdentitySdkCore

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 IdentitySdkCore

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

freshAccessToken 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: 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 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
    • de - Deutsch

    • en - English

    • es - Español

    • fr - Français

    • it - Italiano

    • nl - Nederlands

    • ru - Ру́сский (Russian)

    • pt - Portuguese

    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.

  • AuthFailure(reason: String) if the authentication has failed.

  • AuthCanceled if the authentication was cancelled.

  • TechnicalError(reason: String) if it’s an internal server error.

Feedback