Skip to content
BuildBase
HTTP API menu

Get a dynamically registered client's configuration

RFC 7592 client read, authenticated with the registration access token as a Bearer token (401 invalid_token otherwise, including for unknown clients).

GET/api/v1/auth/oauth2/register/clientId

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); up to 30 requests a minute per IP address.

RFC 7592 client read, authenticated with the registration access token as a Bearer token (401 invalid_token otherwise, including for unknown clients). Each successful read rotates the registration access token and returns the new one, so the client must replace its stored token.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
clientIdstringYes--

Example request

Replace each YOUR_... value with your own.

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

response = requests.get(
    "https://api.console.buildbase.app/api/v1/auth/oauth2/register/YOUR_CLIENT_ID",
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "client_id": "H3g33Wx7by8SVqZ7QihNRASSNQaQEeVWWPfItsTF",
  "client_name": "Audit Test Agent",
  "client_secret": "[REDACTED]",
  "client_secret_expires_at": 0,
  "grant_types": ["authorization_code", "refresh_token"],
  "redirect_uris": ["https://agent.example.com/callback"],
  "registration_access_token": "[REDACTED]",
  "registration_client_uri": "http://localhost:3000/api/v1/auth/oauth2/register/H3g33Wx7by8SVqZ7QihNRASSNQaQEeVWWPfItsTF?org=000000000000000000000001",
  "response_types": ["code"],
  "scope": "",
  "token_endpoint_auth_method": "[REDACTED]"
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

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
}