API keys

POST api key create

Create a new API key for a user

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

configId?string

The configuration ID to use for the API key. If not provided, the default configuration will be used.

name?string

Name of the Api Key

expiresIn?|

Expiration time of the Api Key in seconds

prefix?string

Prefix of the Api Key

remaining?|

Remaining number of requests. Server side only

metadata?unknown

refillAmount?number

Amount to refill the remaining count of the Api Key. server-only. Eg: 100

refillInterval?number

Interval to refill the Api Key in milliseconds. server-only. Eg: 1000

rateLimitTimeWindow?number

The duration in milliseconds where each request is counted. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 1000

rateLimitMax?number

Maximum amount of requests allowed within a window. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 100

rateLimitEnabled?boolean

Whether the key has rate limiting enabled. server-only. Eg: true

permissions?

Permissions of the Api Key.

userId?string

User Id of the user that the Api Key belongs to. server-only. Eg: "user-id"

organizationId?string

Organization Id of the organization that the Api Key belongs to. Eg: 'org-id'

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/api-key/create" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "prefix": "string",  "start": "string",  "key": "string",  "enabled": true,  "expiresAt": "2019-08-24T14:15:22Z",  "referenceId": "string",  "lastRefillAt": "2019-08-24T14:15:22Z",  "lastRequest": "2019-08-24T14:15:22Z",  "metadata": {},  "rateLimitMax": 0,  "rateLimitTimeWindow": 0,  "remaining": 0,  "refillAmount": 0,  "refillInterval": 0,  "rateLimitEnabled": true,  "requestCount": 0,  "permissions": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

POST api key delete

Delete an existing API key

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

keyId*string

The id of the API key to delete

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/api-key/delete" \  -H "Content-Type: application/json" \  -d '{    "keyId": "string"  }'

{  "success": true}

GET api key get

Retrieve an existing API key by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Query Parameters

configId?string

The configuration ID to use for the API key lookup. If not provided, the default configuration will be used.

id?string

The id of the Api Key

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/api-key/get"

{  "id": "string",  "name": "string",  "start": "string",  "prefix": "string",  "userId": "string",  "refillInterval": 0,  "refillAmount": 0,  "lastRefillAt": "2019-08-24T14:15:22Z",  "enabled": true,  "rateLimitEnabled": true,  "rateLimitTimeWindow": 0,  "rateLimitMax": 0,  "requestCount": 0,  "remaining": 0,  "lastRequest": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "permissions": "string"}

GET api key list

List all API keys for the authenticated user or for a specific organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/api-key/list"

{  "apiKeys": [    {      "id": "string",      "name": "string",      "start": "string",      "prefix": "string",      "userId": "string",      "refillInterval": 0,      "refillAmount": 0,      "lastRefillAt": "2019-08-24T14:15:22Z",      "enabled": true,      "rateLimitEnabled": true,      "rateLimitTimeWindow": 0,      "rateLimitMax": 0,      "requestCount": 0,      "remaining": 0,      "lastRequest": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "metadata": {},      "permissions": "string"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

POST api key update

Update an existing API key by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

configId?string

The configuration ID to use for the API key lookup. If not provided, the default configuration will be used.

keyId*string

The id of the Api Key

userId?string

The id of the user which the api key belongs to. server-only. Eg: "some-user-id"

name?string

The name of the key

enabled?boolean

Whether the Api Key is enabled or not

remaining?number

The number of remaining requests

refillAmount?number

The refill amount

refillInterval?number

The refill interval

metadata?unknown

expiresIn?|

Expiration time of the Api Key in seconds

rateLimitEnabled?boolean

Whether the key has rate limiting enabled.

rateLimitTimeWindow?number

The duration in milliseconds where each request is counted. server-only. Eg: 1000

rateLimitMax?number

permissions?|

Update the permissions on the API Key. server-only.

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/api-key/update" \  -H "Content-Type: application/json" \  -d '{    "keyId": "string"  }'

{  "id": "string",  "name": "string",  "start": "string",  "prefix": "string",  "userId": "string",  "refillInterval": 0,  "refillAmount": 0,  "lastRefillAt": "2019-08-24T14:15:22Z",  "enabled": true,  "rateLimitEnabled": true,  "rateLimitTimeWindow": 0,  "rateLimitMax": 0,  "requestCount": 0,  "remaining": 0,  "lastRequest": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "metadata": {},  "permissions": "string"}

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`