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
54 lines
1.2 KiB
Plaintext
54 lines
1.2 KiB
Plaintext
---
|
|
title: "Check User API Key"
|
|
description: "Validate a user API key and check if it is currently active."
|
|
api: "POST /api/v1/user-api-keys/check"
|
|
---
|
|
|
|
## Request
|
|
|
|
<ParamField header="x-stack-secret-server-key" type="string" required>
|
|
The secret server key for authentication.
|
|
</ParamField>
|
|
|
|
<ParamField header="x-stack-project-id" type="string" required>
|
|
The project ID.
|
|
</ParamField>
|
|
|
|
<ParamField body="api_key" type="string" required>
|
|
The user API key value to validate.
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
<ResponseField name="is_valid" type="boolean">
|
|
Whether the API key is valid and active.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="id" type="string">
|
|
The unique identifier of the API key, if valid.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="user_id" type="string">
|
|
The identifier of the user the API key belongs to, if valid.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
```bash cURL
|
|
curl -X POST 'https://api.stack-auth.com/api/v1/user-api-keys/check' \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
|
|
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
|
|
-d '{
|
|
"api_key": "uak_live_abc123def456..."
|
|
}'
|
|
```
|
|
|
|
```json 200 Response
|
|
{
|
|
"is_valid": true,
|
|
"id": "uak_1234567890",
|
|
"user_id": "usr_1234567890"
|
|
}
|
|
```
|
|
</CodeGroup>
|