# Update the company's access policy

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

`PUT /api/v1/public/workspaces/workspaceId/enterprise/policy`

- 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 `policy` at `manage` and a recent re-authentication (403 `reauth_required`). 403 `managed_by_app` while the app's team keeps the policy; 409 `would_lock_you_out` when the allowlist leaves out this request's own address; 422 `not_enterprise_people` or `not_connected_apps`.

## Request

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

Send the body as `application/json`. The body is optional.

| Field                    | Type            | Required | Constraints                                       | Description |
| ------------------------ | --------------- | -------- | ------------------------------------------------- | ----------- |
| `idleMinutes`            | integer or null | No       | at least 0                                        | -           |
| `maxSessionHours`        | integer or null | No       | at least 0                                        | -           |
| `ipAllowlist`            | object          | No       | -                                                 | -           |
| `ipAllowlist.enabled`    | boolean         | No       | -                                                 | -           |
| `ipAllowlist.ranges`     | array of string | No       | at most 100 items                                 | -           |
| `breakGlass`             | object          | No       | -                                                 | -           |
| `breakGlass.emails`      | array of string | No       | at most 5 items                                   | -           |
| `breakGlass.passkeyOnly` | boolean         | No       | -                                                 | -           |
| `companyManages`         | boolean         | No       | -                                                 | -           |
| `domainJoin`             | string          | No       | one of `"off"`, `"join"`, `"request"`             | -           |
| `appTeamSessions`        | string          | No       | one of `"allowed"`, `"refused"`                   | -           |
| `outsiders`              | object          | No       | -                                                 | -           |
| `outsiders.mode`         | string          | No       | one of `"allowed"`, `"limited"`, `"blocked"`      | -           |
| `outsiders.maxRole`      | string          | No       | one of `"editor"`, `"viewer"`                     | -           |
| `signInMethods`          | object or null  | No       | -                                                 | -           |
| `signInMethods.allowed`  | array of string | No       | at least 1 items, at most 15 items, no duplicates | -           |
| `connectedApps`          | object          | No       | -                                                 | -           |
| `connectedApps.mode`     | string          | No       | one of `"any"`, `"approved"`, `"none"`            | -           |
| `connectedApps.approved` | array of string | No       | at most 50 items                                  | -           |

## 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/policy" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "idleMinutes": 0,
  "maxSessionHours": 0,
  "ipAllowlist": {
    "enabled": true,
    "ranges": [
      "string"
    ]
  }
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/policy',
  {
    method: 'PUT',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      idleMinutes: 0,
      maxSessionHours: 0,
      ipAllowlist: {
        enabled: true,
        ranges: ['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/policy",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "idleMinutes": 0,
        "maxSessionHours": 0,
        "ipAllowlist": {
            "enabled": True,
            "ranges": [
                "string",
            ],
        },
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "appTeamSessions": "allowed",
  "breakGlass": {
    "passkeyOnly": false,
    "people": [
      {
        "email": "user@example.com",
        "name": "Session User stepup-carl",
        "userId": "000000000000000000000001"
      }
    ]
  },
  "companyManages": true,
  "connectedApps": {
    "approved": [],
    "mode": "any"
  },
  "domainJoin": "off",
  "idleMinutes": 15,
  "ipAllowlist": {
    "enabled": false,
    "ranges": []
  },
  "maxSessionHours": null,
  "networkRestriction": {
    "companyId": "000000000000000000000002",
    "header": "allowed-company-ids",
    "hosts": ["localhost:3000"],
    "received": null
  },
  "outsiders": {
    "maxRole": "viewer",
    "mode": "allowed"
  },
  "signInMethods": {
    "allowed": null,
    "offered": ["password", "magic_link", "passkey", "github"],
    "outside": {
      "people": 0,
      "sessions": 0
    },
    "people": 4,
    "withPasskey": 0
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "workspaceExceptions": [],
  "yourIp": "127.0.0.1"
}
```

### 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.policy_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.policy.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
