# Replace which identity provider signs in each verified domain

Needs company access setup at manage and a recent re-authentication (403 reauth_required).

`PUT /api/v1/public/workspaces/workspaceId/enterprise/sso/routing`

- 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 company access `setup` at `manage` and a recent re-authentication (403 `reauth_required`). Replaces the whole routing by compare-and-set on `version` (409 `sso_routing_conflict`; 400 `sso_routing_invalid`) and returns the SSO status.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

Send the body as `application/json`.

| Field                  | Type            | Required | Constraints                       | Description |
| ---------------------- | --------------- | -------- | --------------------------------- | ----------- |
| `version`              | integer         | Yes      | at least 0                        | -           |
| `defaultConnection`    | string or null  | Yes      | 1 to 32 characters                | -           |
| `routes`               | array of object | Yes      | at most 50 items                  | -           |
| `routes[].domain`      | string          | Yes      | 1 to 253 characters               | -           |
| `routes[].connections` | array of string | Yes      | at least 1 items, at most 6 items | -           |
| `labels`               | array of object | Yes      | at most 10 items                  | -           |
| `labels[].connection`  | string          | Yes      | 1 to 32 characters                | -           |
| `labels[].label`       | string          | Yes      | at most 240 characters            | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X PUT "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/sso/routing" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "version": 0,
  "defaultConnection": "string",
  "routes": [
    {
      "domain": "string",
      "connections": [
        "string"
      ]
    }
  ],
  "labels": [
    {
      "connection": "string",
      "label": "string"
    }
  ]
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/sso/routing',
  {
    method: 'PUT',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      version: 0,
      defaultConnection: 'string',
      routes: [
        {
          domain: 'string',
          connections: ['string'],
        },
      ],
      labels: [
        {
          connection: 'string',
          label: 'string',
        },
      ],
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.put(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/sso/routing",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "version": 0,
        "defaultConnection": "string",
        "routes": [
            {
                "domain": "string",
                "connections": [
                    "string",
                ],
            },
        ],
        "labels": [
            {
                "connection": "string",
                "label": "string",
            },
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "beyondLimit": 0,
  "checkedAt": "2026-01-01T00:00:00.000Z",
  "connectionState": "active",
  "connections": [
    {
      "certificate": null,
      "domains": ["m20-conn-1767225600000.test"],
      "isDefault": true,
      "label": "Okta",
      "provider": "okta",
      "ref": "3ba2549547cce687",
      "state": "active",
      "type": "OktaSAML"
    },
    {
      "certificate": null,
      "domains": ["umbrella-m20-conn-1767225600000.test"],
      "isDefault": false,
      "label": "Umbrella (Entra)",
      "provider": "entra",
      "ref": "3739e26a2b7b60d2",
      "state": "active",
      "type": "AzureSAML"
    }
  ],
  "limits": {
    "connections": 10,
    "labelMax": 60,
    "perDomain": 5,
    "routes": 50
  },
  "routing": {
    "confirmed": true,
    "defaultRef": "3ba2549547cce687",
    "routes": [
      {
        "domain": "umbrella-m20-conn-1767225600000.test",
        "refs": ["3739e26a2b7b60d2"]
      }
    ],
    "unservedDomains": [],
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedBy": "Session User m20-conn-owner",
    "version": 2
  }
}
```

### 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.

```json title="Example"
{
  "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.

```text title="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.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Events

A successful call can send these [webhook events](/webhooks/overview) to the endpoints that subscribe to them:

- [`enterprise.sso_routing_updated`](/webhooks/overview#when-each-event-fires)

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.enterprise.sso.routing.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
