Skip to content

Make a one-time password reset link for a user (REQ-082). The URL appears one time.

POST
/admin/reset-links
curl --request POST \
--url https://example.com/api/v1/admin/reset-links \
--header 'Content-Type: application/json' \
--data '{ "email": "example" }'
Media typeapplication/json
object
email
required
string
Examplegenerated
{
"email": "example"
}

The link.

Media typeapplication/json
object
url
required
string
Examplegenerated
{
"url": "example"
}

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}