Skip to content

Commit 13fccd3

Browse files
madster456madster456
committed
Add docs-mintlify to root
1 parent 998b366 commit 13fccd3

374 files changed

Lines changed: 29972 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs-mintlify/api/admin/anonymous/sign-up.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: "Sign Up Anonymously"
3+
description: "Create a new anonymous account with no email address."
4+
api: "POST /api/v1/auth/anonymous/sign-up"
5+
---
6+
7+
## Request
8+
9+
<ParamField header="x-stack-secret-server-key" type="string" required>
10+
The secret server key for authentication.
11+
</ParamField>
12+
13+
<ParamField header="x-stack-admin-access-token" type="string">
14+
The admin access token.
15+
</ParamField>
16+
17+
<ParamField header="x-stack-project-id" type="string" required>
18+
The project ID.
19+
</ParamField>
20+
21+
## Response
22+
23+
<ResponseField name="access_token" type="string">
24+
The access token for the newly created anonymous user.
25+
</ResponseField>
26+
27+
<ResponseField name="refresh_token" type="string">
28+
The refresh token for the newly created anonymous user.
29+
</ResponseField>
30+
31+
<ResponseField name="user_id" type="string">
32+
The unique identifier of the newly created anonymous user.
33+
</ResponseField>
34+
35+
<CodeGroup>
36+
```bash cURL
37+
curl -X POST 'https://api.stack-auth.com/api/v1/auth/anonymous/sign-up' \
38+
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
39+
-H 'x-stack-project-id: YOUR_PROJECT_ID'
40+
```
41+
42+
```json 200 Response
43+
{
44+
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
45+
"refresh_token": "abc123def456...",
46+
"user_id": "usr_1234567890"
47+
}
48+
```
49+
</CodeGroup>

‎docs-mintlify/api/admin/api-keys/check-team-api-key.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Check Team API Key"
3+
description: "Validate a team API key and check if it is currently active."
4+
api: "POST /api/v1/team-api-keys/check"
5+
---
6+
7+
## Request
8+
9+
<ParamField header="x-stack-secret-server-key" type="string" required>
10+
The secret server key for authentication.
11+
</ParamField>
12+
13+
<ParamField header="x-stack-admin-access-token" type="string">
14+
The admin access token.
15+
</ParamField>
16+
17+
<ParamField header="x-stack-project-id" type="string" required>
18+
The project ID.
19+
</ParamField>
20+
21+
<ParamField body="api_key" type="string" required>
22+
The team API key value to validate.
23+
</ParamField>
24+
25+
## Response
26+
27+
<ResponseField name="is_valid" type="boolean">
28+
Whether the API key is valid and active.
29+
</ResponseField>
30+
31+
<ResponseField name="id" type="string">
32+
The unique identifier of the API key, if valid.
33+
</ResponseField>
34+
35+
<ResponseField name="team_id" type="string">
36+
The identifier of the team the API key belongs to, if valid.
37+
</ResponseField>
38+
39+
<CodeGroup>
40+
```bash cURL
41+
curl -X POST 'https://api.stack-auth.com/api/v1/team-api-keys/check' \
42+
-H 'Content-Type: application/json' \
43+
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
44+
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
45+
-d '{
46+
"api_key": "tak_live_abc123def456..."
47+
}'
48+
```
49+
50+
```json 200 Response
51+
{
52+
"is_valid": true,
53+
"id": "tak_1234567890",
54+
"team_id": "team_1234567890"
55+
}
56+
```
57+
</CodeGroup>

‎docs-mintlify/api/admin/api-keys/check-user-api-key.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Check User API Key"
3+
description: "Validate a user API key and check if it is currently active."
4+
api: "POST /api/v1/user-api-keys/check"
5+
---
6+
7+
## Request
8+
9+
<ParamField header="x-stack-secret-server-key" type="string" required>
10+
The secret server key for authentication.
11+
</ParamField>
12+
13+
<ParamField header="x-stack-admin-access-token" type="string">
14+
The admin access token.
15+
</ParamField>
16+
17+
<ParamField header="x-stack-project-id" type="string" required>
18+
The project ID.
19+
</ParamField>
20+
21+
<ParamField body="api_key" type="string" required>
22+
The user API key value to validate.
23+
</ParamField>
24+
25+
## Response
26+
27+
<ResponseField name="is_valid" type="boolean">
28+
Whether the API key is valid and active.
29+
</ResponseField>
30+
31+
<ResponseField name="id" type="string">
32+
The unique identifier of the API key, if valid.
33+
</ResponseField>
34+
35+
<ResponseField name="user_id" type="string">
36+
The identifier of the user the API key belongs to, if valid.
37+
</ResponseField>
38+
39+
<CodeGroup>
40+
```bash cURL
41+
curl -X POST 'https://api.stack-auth.com/api/v1/user-api-keys/check' \
42+
-H 'Content-Type: application/json' \
43+
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
44+
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
45+
-d '{
46+
"api_key": "uak_live_abc123def456..."
47+
}'
48+
```
49+
50+
```json 200 Response
51+
{
52+
"is_valid": true,
53+
"id": "uak_1234567890",
54+
"user_id": "usr_1234567890"
55+
}
56+
```
57+
</CodeGroup>

‎docs-mintlify/api/admin/api-keys/create-team-api-key.mdx‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "Create Team API Key"
3+
description: "Create a new API key for a team."
4+
api: "POST /api/v1/team-api-keys"
5+
---
6+
7+
## Request
8+
9+
<ParamField header="x-stack-secret-server-key" type="string" required>
10+
The secret server key for authentication.
11+
</ParamField>
12+
13+
<ParamField header="x-stack-admin-access-token" type="string">
14+
The admin access token.
15+
</ParamField>
16+
17+
<ParamField header="x-stack-project-id" type="string" required>
18+
The project ID.
19+
</ParamField>
20+
21+
<ParamField body="team_id" type="string" required>
22+
The identifier of the team to create the API key for.
23+
</ParamField>
24+
25+
<ParamField body="description" type="string">
26+
A human-readable description for the API key.
27+
</ParamField>
28+
29+
<ParamField body="expires_at" type="string">
30+
ISO 8601 timestamp of when the API key should expire. If not provided, the key does not expire.
31+
</ParamField>
32+
33+
## Response
34+
35+
<ResponseField name="id" type="string">
36+
The unique identifier of the newly created API key.
37+
</ResponseField>
38+
39+
<ResponseField name="description" type="string">
40+
The description of the API key.
41+
</ResponseField>
42+
43+
<ResponseField name="team_id" type="string">
44+
The identifier of the team this API key belongs to.
45+
</ResponseField>
46+
47+
<ResponseField name="api_key" type="string">
48+
The actual API key value. This is only returned once at creation time.
49+
</ResponseField>
50+
51+
<ResponseField name="expires_at" type="string">
52+
ISO 8601 timestamp of when the API key expires, or `null` if it does not expire.
53+
</ResponseField>
54+
55+
<ResponseField name="created_at" type="string">
56+
ISO 8601 timestamp of when the API key was created.
57+
</ResponseField>
58+
59+
<Note>
60+
The `api_key` value is only returned in the creation response. Make sure to store it securely, as it cannot be retrieved again.
61+
</Note>
62+
63+
<CodeGroup>
64+
```bash cURL
65+
curl -X POST 'https://api.stack-auth.com/api/v1/team-api-keys' \
66+
-H 'Content-Type: application/json' \
67+
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
68+
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
69+
-d '{
70+
"team_id": "team_1234567890",
71+
"description": "Production API key",
72+
"expires_at": "2025-12-31T23:59:59Z"
73+
}'
74+
```
75+
76+
```json 200 Response
77+
{
78+
"id": "tak_1234567890",
79+
"description": "Production API key",
80+
"team_id": "team_1234567890",
81+
"api_key": "tak_live_abc123def456...",
82+
"expires_at": "2025-12-31T23:59:59Z",
83+
"created_at": "2024-01-01T00:00:00Z"
84+
}
85+
```
86+
</CodeGroup>

‎docs-mintlify/api/admin/api-keys/create-user-api-key.mdx‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "Create User API Key"
3+
description: "Create a new API key for a user."
4+
api: "POST /api/v1/user-api-keys"
5+
---
6+
7+
## Request
8+
9+
<ParamField header="x-stack-secret-server-key" type="string" required>
10+
The secret server key for authentication.
11+
</ParamField>
12+
13+
<ParamField header="x-stack-admin-access-token" type="string">
14+
The admin access token.
15+
</ParamField>
16+
17+
<ParamField header="x-stack-project-id" type="string" required>
18+
The project ID.
19+
</ParamField>
20+
21+
<ParamField body="user_id" type="string" required>
22+
The identifier of the user to create the API key for.
23+
</ParamField>
24+
25+
<ParamField body="description" type="string">
26+
A human-readable description for the API key.
27+
</ParamField>
28+
29+
<ParamField body="expires_at" type="string">
30+
ISO 8601 timestamp of when the API key should expire. If not provided, the key does not expire.
31+
</ParamField>
32+
33+
## Response
34+
35+
<ResponseField name="id" type="string">
36+
The unique identifier of the newly created API key.
37+
</ResponseField>
38+
39+
<ResponseField name="description" type="string">
40+
The description of the API key.
41+
</ResponseField>
42+
43+
<ResponseField name="user_id" type="string">
44+
The identifier of the user this API key belongs to.
45+
</ResponseField>
46+
47+
<ResponseField name="api_key" type="string">
48+
The actual API key value. This is only returned once at creation time.
49+
</ResponseField>
50+
51+
<ResponseField name="expires_at" type="string">
52+
ISO 8601 timestamp of when the API key expires, or `null` if it does not expire.
53+
</ResponseField>
54+
55+
<ResponseField name="created_at" type="string">
56+
ISO 8601 timestamp of when the API key was created.
57+
</ResponseField>
58+
59+
<Note>
60+
The `api_key` value is only returned in the creation response. Make sure to store it securely, as it cannot be retrieved again.
61+
</Note>
62+
63+
<CodeGroup>
64+
```bash cURL
65+
curl -X POST 'https://api.stack-auth.com/api/v1/user-api-keys' \
66+
-H 'Content-Type: application/json' \
67+
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
68+
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
69+
-d '{
70+
"user_id": "usr_1234567890",
71+
"description": "My API key",
72+
"expires_at": "2025-12-31T23:59:59Z"
73+
}'
74+
```
75+
76+
```json 200 Response
77+
{
78+
"id": "uak_1234567890",
79+
"description": "My API key",
80+
"user_id": "usr_1234567890",
81+
"api_key": "uak_live_abc123def456...",
82+
"expires_at": "2025-12-31T23:59:59Z",
83+
"created_at": "2024-01-01T00:00:00Z"
84+
}
85+
```
86+
</CodeGroup>

0 commit comments

Comments
 (0)