Exchange an org API token for a session id
No session: the API token is the credential.
POST/api/v1/public/token/exchange
- 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 120 requests a minute per IP address.
No session: the API token is the credential. Creates a session for the token's user, or for userId, which only an owner or admin key may name (403 otherwise); workspaceId must be a workspace the user belongs to. Answers 403 when the org's API keys are suspended or the person's company refuses app-team sessions.
Request
Send the body as application/json.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
token | string | Yes | at least 3 characters | - |
userId | string | No | - | - |
workspaceId | string | No | - | - |
expiresIn | number | No | at least 60, at most 2592000 | - |
reason | string | No | at most 200 characters | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/public/token/exchange" \
-H "Content-Type: application/json" \
-d '{
"token": "string"
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/token/exchange',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
token: 'string',
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/public/token/exchange",
json={
"token": "string",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"expiresIn": 2592000,
"orgId": "000000000000000000000001",
"sessionId": "3dECcGbWlgffaUwhk4tzxXmLF829m45t1lH",
"userId": "000000000000000000000002"
}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"
}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.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Events
A successful call can send these webhook events to the endpoints that subscribe to them:
Related
- Token guide: how this part of BuildBase works
- All Token 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
token.exchange.createin public-v1.json