Skip to content
BuildBase
HTTP API menu

Complete sign-in and redirect to the client with an authorization code

The hosted sign-in page returns here with a one-time internal code; the handler checks it, refuses codes minted before a password change, and redirects to...

Warning

Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

GET/api/v1/auth/oauth2/callback/tokenId

Sign-in
None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

The hosted sign-in page returns here with a one-time internal code; the handler checks it, refuses codes minted before a password change, and redirects to the client's redirect URI with a new OAuth 2.0 authorization code and the original state. Agent clients need a recorded consent covering the requested scopes, otherwise the client receives access_denied. Answers 400 when the sign-in request has expired or the code is invalid.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
tokenIdstringYes--

Example request

Replace each YOUR_... value with your own.

curl -X GET "https://api.console.buildbase.app/api/v1/auth/oauth2/callback/YOUR_TOKEN_ID"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/oauth2/callback/YOUR_TOKEN_ID',
  {
    method: 'GET',
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/auth/oauth2/callback/YOUR_TOKEN_ID",
    timeout=30,
)
response.raise_for_status()
data = response.text

Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

Errors

Each refusal, what it means, and what to do. The request changed nothing.

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}