116 lines
1.5 KiB
Markdown
116 lines
1.5 KiB
Markdown
# Api Key Handled Models
|
|
|
|
## Application
|
|
|
|
### Create/Update
|
|
|
|
Model:
|
|
|
|
Create:
|
|
|
|
```json
|
|
{
|
|
"type": 0,
|
|
"name": "string",
|
|
"description": "string",
|
|
}
|
|
```
|
|
|
|
Update:
|
|
|
|
```json
|
|
{
|
|
"id": 0,
|
|
"type": 0,
|
|
"name": "string",
|
|
"description": "string",
|
|
}
|
|
```
|
|
|
|
Sample:
|
|
|
|
Create:
|
|
|
|
```json
|
|
{
|
|
"type": 0,
|
|
"name": "TestApp",
|
|
"description": "a Simple Test App for ApiKey Testing on xDashboard based Projects ...",
|
|
}
|
|
```
|
|
|
|
Update:
|
|
|
|
```json
|
|
{
|
|
"id": 0,
|
|
"type": 0,
|
|
"name": "TestAppEdit",
|
|
"description": "a Edited Simple Test App for ApiKey Testing on xDashboard based Projects ...",
|
|
}
|
|
```
|
|
|
|
## ApiKey
|
|
|
|
### Create
|
|
|
|
Model:
|
|
|
|
```json
|
|
{
|
|
"rateLimit": 0,
|
|
"expirationMinutes": 0,
|
|
"scopes": [
|
|
"string"
|
|
],
|
|
"allowedIPs": [
|
|
"string"
|
|
]
|
|
}
|
|
```
|
|
|
|
Sample:
|
|
|
|
```json
|
|
{
|
|
"rateLimit": 50,
|
|
"expirationMinutes": 40,
|
|
"scopes": [
|
|
"manage"
|
|
],
|
|
"allowedIPs": []
|
|
}
|
|
```
|
|
|
|
### Update
|
|
|
|
Model:
|
|
|
|
```json
|
|
{
|
|
"revokedBy": "string",
|
|
"allowedIPs": "string",
|
|
"rateLimitPerMinute": 0,
|
|
"allowedScopes": "string",
|
|
"expiresAt": "2026-10-08T11:30:15.484Z",
|
|
"revokedAt": "2026-10-08T11:30:15.484Z",
|
|
"lastUsedAt": "2026-10-08T11:30:15.484Z",
|
|
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
}
|
|
```
|
|
|
|
Sample:
|
|
|
|
```json
|
|
{
|
|
"revokedBy": "string",
|
|
"allowedIPs": "string",
|
|
"rateLimitPerMinute": 0,
|
|
"allowedScopes": "string",
|
|
"expiresAt": "2026-10-08T11:30:15.484Z",
|
|
"revokedAt": "2026-10-08T11:30:15.484Z",
|
|
"lastUsedAt": "2026-10-08T11:30:15.484Z",
|
|
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
}
|
|
```
|