users_apikeys_create
Issue an API key for this product.
Issue an API key for this product. type='server' mints a secret backend key (usk_…) returned EXACTLY ONCE — it authenticates the code-exchange leg and is stored only as a hash, so a lost key must be replaced, never recovered. type='publishable' mints a non-secret browser key (upk_…) that only names this product and stays readable afterwards.
Behavior
- HTTP
POST /users/api-keys
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | • | A label only humans read — which backend or environment holds this key. |
| type | string | • | 'server' mints a SECRET key (usk_…) for the Product's backend — returned exactly once and stored hashed. 'publishable' mints a non-secret key (upk_…) that identifies this product in browser flows and stays readable. |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | |
| key | string | • | |
| name | string | • | |
| type | string | • | |
| value | string | • | |
| prefix | string | • | |
| createdAt | string | • | |
| revokedAt | string | • |
Try it
Issue an API key for this product.