Create API key

POST

/api-keys

Issues a new API key for the organization. The plaintext value is returned once, at creation, and is never retrievable again.

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

This endpoint expects an object.

namestringRequired1-255 characters

permissionslist of stringsOptionalDefaults to []

canImpersonatebooleanOptionalDefaults to false

The created API key, including its plaintext value.

idstring

namestring

permissionslist of strings

canImpersonateboolean

lastUsedAtstring or null

createdAtstring

valuestring

The plaintext key, returned only at creation.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

1	curl -X POST https:/https://apihttps://api-keys \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "RakerOne Integration Key"
6	}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
3	"name": "RakerOne Integration Key",
4	"permissions": [
5	"read:playbooks",
6	"write:tasks"
7	],
8	"canImpersonate": false,
9	"lastUsedAt": "2024-06-10T09:15:00Z",
10	"createdAt": "2024-06-10T08:00:00Z",
11	"value": "rk_4f7e8d9c2b3a1e0f"
12	}