Reset Password

Resets password using a one-time token received via the forgot-password email. On success, all existing refresh tokens are revoked for security. Access tokens may continue until expiry.

Headers

X-Correlation-Id
Type: string

Optional caller-provided correlation ID; echoed in responses when present.

Body·

required

application/json

client
Type: string
required

OAuth client ID provided by the business. Required to identify the client application for reset password. The OAuth application must have the Advance Auth scope enabled.
user
Type: object
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

post/api2/basic_auth/reset_password

curl https://SERVER_NAME_GOES_HERE/api2/basic_auth/reset_password \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "user": {
    "reset_token": "RESET_TOKEN_GOES_HERE",
    "new_password": "PASSWORD_GOES_HERE",
    "password_confirmation": "PASSWORD_GOES_HERE"
  }
}'

{
  "data": [
    "Your password has been changed successfully."
  ]
}

Password updated; refresh tokens revoked for security