Email a password reset link; the same answer whether or not the address has an account

POST

/v1/auth/password-reset

curl --request POST \
  --url https://example.com/v1/auth/password-reset \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example" }'

Who: anyone.

Request Body^required

Media typeapplication/json

object

email

required

string

Example ^generated

{
  "email": "example"
}

Responses

204

Done; no body

default

An error, as go-commons apperr maps it

Media typeapplication/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}