Create my API key

QA Environment

POST

/api/auth/api-key/create

Auth/API Keys

Last modified:2026-09-30 05:55:41

Maintainer:José María Esparza Arévalo

Creates a key owned by the signed-in user; it inherits that user's organization role and locations. Admins issue keys for integration users with POST /api/organizations/{organizationId}/users/{userId}/api-keys.

Request

Authorization

API Key

Add parameter in cookie

kio-link-bms.session_token

Example:

kio-link-bms.session_token: ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "name": "string",
    "expiresIn": 86400,
    "prefix": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/auth/api-key/create' \
--header 'Origin: {{bmsOrigin}}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "expiresIn": 86400,
    "prefix": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Responses

🟢200

application/json

Success

Bodyapplication/json

Example

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

🟠400AuthBadRequest

🟠401AuthUnauthorized

🟠403AuthForbidden

🟠429AuthTooManyRequests

Modified at 2026-09-30 05:55:41

Sign out

List my API keys