v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Users

Change a User's Password

Change the password for the specified user. Only the current authenticated user can change their own password using this endpoint.

Returns

Returns a 204 No Content response if the password change was successful.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed. Some common error cases: - 400 Bad Request: Invalid or missing password fields. - 403 Forbidden: You are not authorized to change this user's password. - 429 Too Many Requests: Too many failed attempts; try again later.

post/users/{user_id}/settings/password/

Path parameters

user_idstring required

The unique identifier of the user whose password is being changed. Example: abc123

Request body

Example request

{
  "data": {
    "type": "user_passwords",
    "attributes": {
      "existing_password": "current_password_123",
      "new_password": "new_secure_password_456"
    }
  }
}

Response

Password successfully changed. All sessions for the user will be logged out and must be re-authenticated.