A valid request URL is required to generate request examples{
"id": "<string>",
"flow_mode": "user",
"status": "pending",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"required_header_keys": [
"<string>"
],
"has_active_credential": true,
"mcp_client": {
"client_id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"user": {
"id": "<string>",
"name": "<string>"
},
"virtual_key": {
"id": "<string>",
"name": "<string>"
},
"session_id": "<string>",
"admin_header_keys": [
"<string>"
],
"submitted_keys": [
"<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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_type": "<string>"
}
}Get per-user-headers submission flow
Returns the pending submission flow row plus the live MCP client’s schema
(required header names + optional admin header names). Used by the
/workspace/mcp-sessions/auth?flow=<id>&kind=headers landing page to
render the values form.
Requires management API authentication via Authorization: Bearer <API key>.
A valid request URL is required to generate request examples{
"id": "<string>",
"flow_mode": "user",
"status": "pending",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"required_header_keys": [
"<string>"
],
"has_active_credential": true,
"mcp_client": {
"client_id": "<string>",
"name": "<string>"
},
"user_id": "<string>",
"user": {
"id": "<string>",
"name": "<string>"
},
"virtual_key": {
"id": "<string>",
"name": "<string>"
},
"session_id": "<string>",
"admin_header_keys": [
"<string>"
],
"submitted_keys": [
"<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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_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": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_type": "<string>"
}
}| Permission | Granted via |
|---|---|
MCPGateway:View | RBAC role or API key scope |
Authorizations
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 ofBasicAuth).
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.
Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a
Required Permissions table (Resource:Operation, for example Dashboard:View) above
its Authorizations section, and the caller's RBAC role or management API key scopes must
include what it lists, otherwise the request is rejected with 403 Forbidden.
A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.
OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account,
or auth disabled), every management endpoint except the public ones (/health,
/api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the
operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization.
The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN
environment variable. A missing header returns 401, a wrong token 403. The header
stops working once dashboard auth is enabled. The dashboard instead trades the token once
for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup.
See Required permissions for how
permissions are derived and which endpoints are exempt.
Path Parameters
Flow row ID
Response
Flow detail
Response for GET /api/mcp/per-user-headers/flows/{id}. Carries the schema the end-user needs to fill in plus identity binding info for display.
user, vk, session pending, completed, expired Header names the end-user must supply on this submission
True when a credential already exists for the flow's (mode, identity, mcp_client) triple. The submission UI uses this to render an "edit" affordance instead of a fresh form.
Minimal MCP client view embedded in session rows.
Show child attributes
Show child attributes
Minimal user view embedded on user-keyed session rows.
Show child attributes
Show child attributes
Minimal virtual-key view embedded in session rows.
Show child attributes
Show child attributes
Names (not values) of static admin headers attached to every per-user request. Surfaced so the user understands what context will accompany their values.
Names of header keys already on the caller's existing credential.
Populated whenever a credential exists for the binding (both active
and needs_update states — orphaned credentials are filtered
server-side). Values are never returned. has_active_credential only
flips to true when the credential is in active state.
Was this page helpful?