Generate password reset token
Generate a new reset password token for this user
POST
/{apiBasePath}/{tenantId}/user/password/reset/tokenPath parameters
apiBasePathstringrequiredIts value depends on the apiBasePath set by the user
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Header parameters
ridstringThe email password recipe ID
Request body
application/jsonformFieldsformFieldsForm fields for authentication
Show propertiesHide properties
Array of
objectididField identifier
Allowed:
emailpasswordvaluestringField value
Responses
200Generate a new reset password token for this user
One of:
passwordResetTokenResponse
statusstatusOKSuccess status indicator
Allowed:
OKpasswordResetNotAllowedResponse
statusstringError status
Allowed:
PASSWORD_RESET_NOT_ALLOWEDreasonstringReason why password reset is not allowed
fieldErrorResponse
statusstringError status
Allowed:
FIELD_ERRORformFieldsobject[]List of field errors
Show propertiesHide properties
Array of
objectidstringField ID
errorstringError message
generalErrorResponse
statusstringError status code
Allowed:
GENERAL_ERRORmessagestringError message
404Resource not found error
string500Internal server error
stringTry it
Server
Parameters
Bodyapplication/json
Request
curl -X POST "/auth/public/user/password/reset/token" \
-H "Content-Type: application/json" \
-d '{
"formFields": [
{
"id": "email",
"value": "test@email.com"
}
]
}'const response = await fetch("/auth/public/user/password/reset/token", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"formFields": [
{
"id": "email",
"value": "test@email.com"
}
]
})
});import requests
response = requests.post(
"/auth/public/user/password/reset/token",
headers={
"Content-Type": "application/json"
},
json={
"formFields": [
{
"id": "email",
"value": "test@email.com"
}
]
},
)Response
{
"status": "OK"
}"Not Found""Internal Error"