API referenceidentity
Start device authorization
POST
/v1/oauth/device_authorizationStart an MCP grant on a device without a browser (RFC 8628; console and supplier only)
The fallback for an MCP client that cannot open a browser.Show more
The fallback for an MCP client that cannot open a browser. The client sends its client_id, the resource (the plane's /mcp/console or /mcp/supplier URL) and optionally the resource's read scope, and receives a device_code to poll POST /v1/oauth/token with and a user_code for the human. The human opens verification_uri (the realm's Connect page, {consent-base}/console/connect or {consent-base}/supplier/connect), signs in and types the code; there is deliberately no verification_uri_complete, so the code is always typed. user_code is 8 letters of the RFC 8628 section 6.1 base-20 alphabet shown as XXXX-XXXX; it lives 10 minutes and serves one approval, and the device_code is redeemed for tokens once (a later poll is invalid_grant). Poll no faster than interval (5 s); polling faster answers slow_down. The operator resource is refused 400 invalid_target with reason DEVICE_FLOW_NOT_ALLOWED: the operator realm never offers a device flow, on every setting. scope is the resource's read scope, or for console mcp:console:read with mcp:console:write; every other scope is invalid_scope.Request body
This operation takes no request body.
Responses
- 200The codes (RFC 8628 section 3.2)DeviceAuthorizationResponse
- 400OAuthError
invalid_request (a missing or repeated parameter), invalid_scope (a scope the resource does not admit; reason WRITES_DISABLED for mcp:console:write with the write ceiling off) or invalid_target (an…Show more
invalid_request (a missing or repeated parameter), invalid_scope (a scope the resource does not admit; reason WRITES_DISABLED for mcp:console:write with the write ceiling off) or invalid_target (an unknown resource; reason DEVICE_FLOW_NOT_ALLOWED for the operator resource) - 401invalid_client — the client_id is not a registered client or a valid metadata documentOAuthError
- 404NOT_FOUND — unknown or expired ref (unguessable refs, 15)ApiErrorResponse
- 405ApiErrorResponse
VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show more
VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent. - 413ApiErrorResponse
VALIDATION — the request body is larger than the surface's limit.Show more
VALIDATION — the request body is larger than the surface's limit. Not retryable as sent: shrink the body. Declared on every operation that takes a request body. details carries exactly one key, maxBodyBytes (integer): the limit that applies to this surface, in bytes. - 414ApiErrorResponse
VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show more
VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST. - 415ApiErrorResponse
VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes).Show more
VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes). The public edge refuses it before the platform sees it (details.reason UNSUPPORTED_MEDIA_TYPE, details.source edge). Not retryable as sent: send Content-Type application/json. Declared on every operation that takes a JSON request body. - 429ApiErrorResponse
Counted in fixed windows (default 15 min).Show more
Counted in fixed windows (default 15 min). The signup, login, password and invite routes count every attempt per client address AND per subject (the email, the username + site, or the invite token). POST /v1/oauth/token is counted three ways, none of them on client_id alone, so knowing a client_id (which is not secret) never lets anyone spend its holder's budget: oauth-token counts every attempt per client address only; oauth-token-failure counts FAILED client authentications per client address and per (client address, client_id) pair; oauth-token-issued counts tokens issued per client_id only, and only a request whose secret, grant_type and scope all passed can spend it. details.reason says which limit tripped (CLIENT_RATE_LIMITED | SUBJECT_RATE_LIMITED) and details.action which count (signup | signup-verify | login | password-forgot | password-reset | invite-accept | oauth-token | oauth-token-failure | oauth-token-issued). Retry-After is whole seconds to the end of the window, and details.retryAfterMs mirrors it. The answer is the same whether or not the account or key exists, so the limit cannot be used to enumerate accounts, and nothing the caller sent is echoed. adds three counts per client address for the MCP grant routes: oauth-authorize (GET /v1/oauth/authorize, which may fetch a Client ID Metadata Document), oauth-register (POST /v1/oauth/register) and oauth-device (POST /v1/oauth/device_authorization), and one count per MCP grant, oauth-exchange-grant (the token exchange of POST /v1/oauth/token, counted per grant after the exchange client and the subject token verified, default 120 a minute), whose details.reason is EXCHANGE_RATE_LIMITED. - 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse
Errors you should handle
Branch on code and honour retryable — never on the HTTP status alone.
| 404 | NOT_FOUND searchRef SR-F-7b31d0a9 is unknown or has expired; re-search | not retryable |
| 405 | VALIDATION This method is not served. | not retryable |
| 413 | VALIDATION The request body is larger than this API accepts (262144 bytes). | not retryable |
| 414 | VALIDATION The request URI is longer than 8 KiB. | not retryable |
| 415 | VALIDATION Send application/json. | not retryable |
| 429 | RATE_LIMITED Too many requests of this kind for this address or account. Wait for the Retry-After interval before trying again. | retryable |
| 500 | INTERNAL An unexpected error occurred. Quote the traceId to support. | retryable |