mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
63 lines
1.7 KiB
Plaintext
63 lines
1.7 KiB
Plaintext
---
|
|
title: "Send Reset Password Code"
|
|
description: "Send a code to the user's email address for resetting the password."
|
|
api: "POST /api/v1/auth/password/send-reset-code"
|
|
---
|
|
|
|
## Request
|
|
|
|
### Headers
|
|
|
|
<ParamField header="X-Stack-Project-Id" type="string">
|
|
The unique identifier of the project.
|
|
</ParamField>
|
|
|
|
<ParamField header="X-Stack-Publishable-Client-Key" type="string">
|
|
The publishable client key.
|
|
</ParamField>
|
|
|
|
### Body
|
|
|
|
<ParamField body="email" type="string" required>
|
|
The email address of the user requesting a password reset.
|
|
</ParamField>
|
|
|
|
<ParamField body="callback_url" type="string" required>
|
|
The base callback URL to construct the reset link from. A query parameter `code` with the reset code will be appended to it.
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
<ResponseField name="success" type="string" required>
|
|
Indicates the reset code was sent successfully.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
```bash cURL
|
|
curl -X POST "https://api.stack-auth.com/api/v1/auth/password/send-reset-code" \
|
|
-H "Content-Type: application/json" \
|
|
-H "X-Stack-Project-Id: <project-id>" \
|
|
-H "X-Stack-Publishable-Client-Key: <client-key>" \
|
|
-d '{
|
|
"email": "johndoe@example.com",
|
|
"callback_url": "https://example.com/handler/password-reset"
|
|
}'
|
|
```
|
|
|
|
```javascript JavaScript
|
|
const response = await fetch("https://api.stack-auth.com/api/v1/auth/password/send-reset-code", {
|
|
method: "POST",
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
"X-Stack-Project-Id": "<project-id>",
|
|
"X-Stack-Publishable-Client-Key": "<client-key>"
|
|
},
|
|
body: JSON.stringify({
|
|
email: "johndoe@example.com",
|
|
callback_url: "https://example.com/handler/password-reset"
|
|
})
|
|
});
|
|
const data = await response.json();
|
|
```
|
|
</CodeGroup>
|