Reset user password

Reset a password using password reset token

POST/{apiBasePath}/{tenantId}/user/password/reset

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

The email password recipe ID

Request body

application/json

methodmethod

The method to use for the operation

formfieldsformFields

Form fields for authentication

Show properties

Array of object

idid

Field identifier

Allowed:emailpassword

valuestring

Field value

tokentoken

A security token used for authentication

Responses

200Reset a password using password reset token

One of:

passwordResetResponse

statusstring

Success status

Allowed:OK

passwordResetErrorResponse

statusstring

Error status

Allowed:RESET_PASSWORD_INVALID_TOKEN_ERROR

fieldErrorResponse

statusstring

Error status

Allowed:FIELD_ERROR

formFieldsobject[]

List of field errors

Show properties

Array of object

idstring

Field ID

errorstring

Error message

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the usertenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheaderThe email password recipe ID

Bodyapplication/json

Request body

Request

curl -X POST "/auth/public/user/password/reset" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "token",
  "formFields": [
    {
      "id": "password",
      "value": "newPass123"
    }
  ],
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
}'

const response = await fetch("/auth/public/user/password/reset", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "method": "token",
  "formFields": [
    {
      "id": "password",
      "value": "newPass123"
    }
  ],
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
})
});

import requests

response = requests.post(
    "/auth/public/user/password/reset",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "method": "token",
  "formFields": [
    {
      "id": "password",
      "value": "newPass123"
    }
  ],
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
},
)

Response

{
  "status": "OK"
}

"Not Found"

"Internal Error"