Skip to content
BuildBase
HTTP API menu

Start an enterprise SSO sign-in for a discovered email address

No router-level gate; the handler requires a registered redirect origin (400 otherwise) and spends the discovery handle.

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/enterprise/orgId/start/methodId

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.

No router-level gate; the handler requires a registered redirect origin (400 otherwise) and spends the discovery handle. Redirects to WorkOS for the company's connection, or back to the redirect URL with a sso_choose choice id when several connections could serve the email. Refusals (method or company not available, tenant restriction, no routed connection) redirect back with an error and reason.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
orgIdstringYes--
methodIdstringYes--

Query parameters

FieldTypeRequiredConstraintsDescription
authStateIdstringNoat most 128 characters-
challengestringYesmatches ^[A-Za-z0-9_-]{43}$-
handlestringYes1 to 64 characters-
invitationTokenstringNoat most 128 characters-
redirectstringYesformat uri, at most 2048 characters-

Example request

Replace each YOUR_... value with your own.

curl -X GET "https://api.console.buildbase.app/api/v1/auth/enterprise/YOUR_ORG_ID/start/YOUR_METHOD_ID?challenge=YOUR_CHALLENGE&handle=YOUR_HANDLE&redirect=https%3A%2F%2Fexample.com"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/enterprise/YOUR_ORG_ID/start/YOUR_METHOD_ID?challenge=YOUR_CHALLENGE&handle=YOUR_HANDLE&redirect=https%3A%2F%2Fexample.com',
  {
    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/enterprise/YOUR_ORG_ID/start/YOUR_METHOD_ID?challenge=YOUR_CHALLENGE&handle=YOUR_HANDLE&redirect=https%3A%2F%2Fexample.com",
    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.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

404 Not Found

What it means: An id in the path names nothing in this org.

What to do: Check the ids in the path: one of them names nothing in this organization.

Example
{
  "success": false,
  "message": "string"
}

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
}