List users attached to a virtual key

GET /api/governance/virtual-keys/{vk_id}/users

Error

A valid request URL is required to generate request examples

200

{
  "users": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "[e-mail]",
      "role_id": 123,
      "role": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "is_system_role": true
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "teams": [
        {
          "id": "<string>",
          "name": "<string>",
          "business_unit_id": "<string>",
          "business_unit_name": "<string>"
        }
      ],
      "access_profile": {
        "id": 123,
        "user_id": "<string>",
        "parent_profile_id": 123,
        "name": "<string>",
        "is_active": true,
        "expires_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "count": 123
}

This endpoint is available in Bifrost Enterprise only.

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

vk_id · string · required

Response

200 - application/json

Attached users

users · object[] · required

Show child attributes

count · integer · required