Skip to main content
GET
Get the consent URL for per-user MCP server authorization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

mcpServerId
string
required

MCP server id (the id returned by GET /v1/mcp, not the name).

Example:

"mcp-01HXYZ..."

Query Parameters

gatewayBaseURL
string | null

Base URL of the MCP gateway (used as the resource indicator and to substitute {{mcpProxyBaseURL}} for the proxied MCP server URL). Defaults to the tenant's gateway-default installation URL when omitted.

redirectURL
string | null

URL to redirect the user to after completing the OAuth consent flow. Defaults to the tenant's mcp-server-success control-plane page when omitted.

requiredMcpServerNames
string | null

Comma-separated source MCP server names the consent must authorize. Only valid on a virtual MCP server; every other unconnected source is optional.

Response

Per-subject auth status; the AUTHENTICATION_REQUIRED branch carries the consent URL to open.

status
enum<string>
required
Available options:
authenticated,
authentication_required,
authentication_not_required
method
enum<string> | null

Authentication source that satisfied this status.

Available options:
oauth,
auth-override
expiresAt
string | null

When the access token expires (ISO 8601 UTC). Only for OAuth2 credentials.

Example:

"2026-10-01T12:40:00.000Z"

isRefreshable
boolean | null

Whether a new access token can be obtained without the user re-authorizing. Only for OAuth2 credentials.

Example:

true

lastUpdatedAt
string | null

When the stored OAuth2 credential was last written (ISO 8601 UTC).

Example:

"2026-10-01T11:40:00.000Z"

refreshFailureCount
number | null

Consecutive background token refresh failures; 0 when none. Only for OAuth2 credentials.

Example:

0

refreshFailureMessage
string | null

Provider error from the most recent background token refresh failure. Only for OAuth2 credentials.

Example:

"invalid_grant: refresh token expired"