Skip to content
BuildBase
HTTP API menu

Check whether the signed-in person must consent to an agent client

Needs the login token in Authorization and the auth state header; answers 401 otherwise or when the token belongs to another org.

GET/api/v1/auth/consent

Sign-in
No credential. Name the organization with the hosted sign-in state header or the org query parameter.
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.

Needs the login token in Authorization and the auth state header; answers 401 otherwise or when the token belongs to another org. Non-agent clients answer required: false; for an agent client it returns the client, requested scopes, scopes not yet granted and whether consent is required, or a refused block when the person's company does not allow the app.

Request

This operation takes no parameters and no body.

Example request

Replace each YOUR_... value with your own.

curl -X GET "https://api.console.buildbase.app/api/v1/auth/consent?org=YOUR_ORG_ID"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/consent?org=YOUR_ORG_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/consent?org=YOUR_ORG_ID",
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "client": {
    "title": "E2E Scoped Agent",
    "unverified": false
  },
  "grant": {
    "actsAsUser": true,
    "customClaims": [],
    "identity": [
      "id",
      "email",
      "name",
      "role",
      "emailVerified",
      "image",
      "blocked",
      "blockedReason",
      "blockedAt"
    ],
    "idleDays": 30,
    "redirectHost": "localhost:9971",
    "resource": [],
    "scope": ["notes:read", "notes:write"],
    "scopeDetails": []
  },
  "newScope": ["notes:write"],
  "required": true,
  "scope": ["notes:read", "notes:write"],
  "scopeDetails": []
}

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.

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

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
}