Mint an extra virtual key for a user

Issues an additional virtual key for the user.

Virtual keys are scoped to the user, not to any one access profile: what a request may do with the key is read from whichever of the user’s active profiles grants it, and each of those profiles is a separate routing candidate the request may be served by. The user must therefore hold at least one access profile — the request returns 404 otherwise — but the key is not tied to the profile that happened to be current when it was minted, and it survives that profile being detached as long as the user still holds another.

POST /api/governance/users/{user_id}/virtual-keys

Error

A valid request URL is required to generate request examples

200

{
  "virtual_key": {
    "id": "<string>",
    "name": "<string>",
    "value": "<string>"
  }
}

This endpoint is available in Bifrost Enterprise only.

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Path Parameters

user_id · string · required

Body

application/json

name · string

description · string

Response

200

application/json

Virtual key created.

virtual_key · object

Show child attributes