Request a password reset

POST

/v1/iam/auth/forgot-password

curl --request POST \
  --url http://localhost:8080/v1/iam/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

• Dev (Bun.serve, défaut local).
• Remplacer par l'URL prod.

Toujours 200 — même si l’email n’existe pas, on ne révèle pas l’existence.

Request Body ^required

Media type application/json

object

email

required

string format: email

>= 3 characters <= 320 characters

Example ^generated

{
  "email": "hello@example.com"
}

Responses

200

Email envoyé si éligible.

Media type application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

requested

required

boolean

requestedAt

required

string format: date-time

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "requested": true
  }
}

400

Requête mal formée (validation_error, invalid_idempotency_key, invalid_sort_field, invalid_filter).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

429

Rate-limit dépassé. Header Retry-After retourné.

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}