Add an extra virtual key under a user's access profile (deprecated) (deprecated path)

Issues an additional virtual key for the user.

Virtual keys are scoped to the user, not to one access profile: what a request may do with the key is resolved at request time from whichever of the user’s active profiles grant it. So profile_id is ignored — the key minted is the same whichever profile is named, and it is not bound to that profile or removed with it. The user must hold at least one access profile.

POST /api/users/{user_id}/access-profiles/{profile_id}/virtual-keys

Error

A valid request URL is required to generate request examples

200

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

This path is deprecated and will be removed in the following major release. Use /api/governance/users/{user_id}/virtual-keys instead.

This endpoint is available in Bifrost Enterprise only.

Deprecated. Use POST /api/governance/users/{user_id}/virtual-keys instead. This path still works and behaves identically, but will be removed in a future major release.

Authorizations

ManagementBearerAuthBasicAuth

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

profile_id · integer · required

Ignored. Kept so the path shape stays valid for existing clients; keys are user-scoped, so any value produces the same result.

Body

application/json

name · string

description · string

Response

200

application/json

Virtual key created.

virtual_key · object

Show child attributes