Create a short-lived setup link for the company's IT admin
Needs the company access the intent asks for (setup at manage, or activity at view for the audit log viewer) and, except for the audit log viewer, a recent...
POST/api/v1/public/workspaces/workspaceId/enterprise/setup-link
- Sign-in
- A signed-in user's session: send the session id in the x-session-id header.
- 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 60 requests a minute per signedInWriteKey (some requests are not counted).
Needs the company access the intent asks for (setup at manage, or activity at view for the audit log viewer) and, except for the audit log viewer, a recent re-authentication. The link opens the WorkOS Admin Portal on the app owner's own WorkOS account and returns to the app's first redirect URL; 422 client_has_no_redirect or insecure_return_url, 403 directory_not_enabled, 403 app_team_only for an intent the company may not open (such as log_streams), 409 nothing_to_renew.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
workspaceId | string | Yes | - | - |
Send the body as application/json. The body is optional.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
intent | string | No | one of "sso", "dsync", "certificate_renewal", "domain_verification", "audit_logs", "log_streams" | - |
purpose | string | No | one of "roles", "it_contacts" | - |
Example request
Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.
curl -X POST "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/setup-link" \
-H "x-session-id: $BUILDBASE_SESSION_ID" \
-H "Content-Type: application/json" \
-d '{
"intent": "sso",
"purpose": "roles"
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/setup-link',
{
method: 'POST',
headers: {
'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
'Content-Type': 'application/json',
},
body: JSON.stringify({
intent: 'sso',
purpose: 'roles',
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import os
import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/setup-link",
headers={
"x-session-id": os.environ["BUILDBASE_SESSION_ID"],
},
json={
"intent": "sso",
"purpose": "roles",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"action": "roleAssignment",
"expiresAt": "2026-01-01T00:00:00.000Z",
"intent": "sso",
"url": "http://127.0.0.1:4199/init?setupLinkToken=[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.
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.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}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.
Unauthorized429 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.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Workspaces guide: how this part of BuildBase works
- All Workspaces operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
workspaces.enterprise.setupLink.createin public-v1.json