Skip to main content
POST
Error
Required Permissions How permissions work

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.

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. See Required permissions for how permissions are derived and which endpoints are exempt.

Path Parameters

id
string
required

MCP client ID

Response

Reauthorization flow initiated

Response when initiating an OAuth flow

status
enum<string>
Available options:
pending_oauth
message
string
oauth_config_id
string

ID of the OAuth config created for this flow

authorize_url
string

URL to redirect the user to for authorization

expires_at
string<date-time>

When the OAuth authorization request expires

mcp_client_id
string

The MCP client ID that initiated this OAuth flow

complete_url
string

Relative URL to POST once the flow is authorized (/api/mcp/client/{oauth_config_id}/complete-oauth). Note the path parameter is the oauth_config_id, not the MCP client ID.

status_url
string

Relative URL to poll for the flow status (/api/oauth/config/{oauth_config_id}/status). Wait for status "authorized" before calling complete_url.

next_steps
string[]

Human-readable steps to complete the flow (authorize, poll, complete)