Create user governance - Bifrost

Error

A valid request URL is required to generate request examples

{
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "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"
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

POST

/

api

/

governance

/

users

/

{user_id}

/

governance

Error

A valid request URL is required to generate request examples

{
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "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"
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<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

User-scoped governance settings. POST creates settings and PUT partially updates them.

user_id

string

Optional body copy of the path user ID. When present, it must match the path.

budget

object

Create budget request

Show child attributes

budgets

object[]

Show child attributes

rate_limit

object

Create rate limit request

Show child attributes

provider_configs

object[]

Optional Enterprise per-provider governance overrides.

Response

Governance created

user

object

Show child attributes