API ReferenceAuth

Request a password reset

Requests a magic-link password reset email. Always returns a generic success response.

POST
/{appUid}/auth/request-password-reset

Path Parameters

appUid*string

Your app's unique id. Find it in the console under the app's Settings, or in the URL of any app page.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/497f6eca-6276-4993-bfeb-53cbbbba6f08/auth/request-password-reset" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{  "message": "If an account exists for that email, a sign-in link will be sent."}

Remove a sign-in method

Unlinks one provider identity. Refuses to remove the LAST way in — unlinking the only provider on an account with no password would lock the owner out with no recovery path. Hard-deletes, so the same provider account can be linked again later.

Confirm a password reset

Completes a password reset with token and new password.