mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-16 21:08:38 +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
82 lines
2.2 KiB
Plaintext
82 lines
2.2 KiB
Plaintext
---
|
|
title: "Update User API Key"
|
|
description: "Update an existing user API key by applying only the values included in the request payload."
|
|
api: "PATCH /api/v1/user-api-keys/{api_key_id}"
|
|
---
|
|
|
|
## Request
|
|
|
|
<ParamField header="x-stack-secret-server-key" type="string" required>
|
|
The secret server key for authentication.
|
|
</ParamField>
|
|
|
|
<ParamField header="x-stack-admin-access-token" type="string">
|
|
The admin access token.
|
|
</ParamField>
|
|
|
|
<ParamField header="x-stack-project-id" type="string" required>
|
|
The project ID.
|
|
</ParamField>
|
|
|
|
<ParamField path="api_key_id" type="string" required>
|
|
The unique identifier of the user API key to update.
|
|
</ParamField>
|
|
|
|
<ParamField body="description" type="string">
|
|
A new description for the API key.
|
|
</ParamField>
|
|
|
|
<ParamField body="revoked" type="boolean">
|
|
Set to `true` to revoke the API key.
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
<ResponseField name="id" type="string">
|
|
The unique identifier of the API key.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="description" type="string">
|
|
The description of the API key.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="user_id" type="string">
|
|
The identifier of the user this API key belongs to.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="expires_at" type="string">
|
|
ISO 8601 timestamp of when the API key expires, or `null` if it does not expire.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="manually_revoked_at" type="string">
|
|
ISO 8601 timestamp of when the API key was manually revoked, or `null` if it has not been revoked.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="created_at" type="string">
|
|
ISO 8601 timestamp of when the API key was created.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
```bash cURL
|
|
curl -X PATCH 'https://api.stack-auth.com/api/v1/user-api-keys/uak_1234567890' \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
|
|
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
|
|
-d '{
|
|
"description": "Updated API key description",
|
|
"revoked": false
|
|
}'
|
|
```
|
|
|
|
```json 200 Response
|
|
{
|
|
"id": "uak_1234567890",
|
|
"description": "Updated API key description",
|
|
"user_id": "usr_1234567890",
|
|
"expires_at": "2025-12-31T23:59:59Z",
|
|
"manually_revoked_at": null,
|
|
"created_at": "2024-01-01T00:00:00Z"
|
|
}
|
|
```
|
|
</CodeGroup>
|