# Set the stricter policy for one of the company's workspaces

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

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

- 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`). Rules may not be looser than the company's (422 per field); 403 `managed_by_app`; 409 `would_lock_you_out` when the caller's own session would fail the new rules.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |
| `targetId`    | 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 or null  | No       | -                                                 | -           |
| `ipAllowlist.ranges`     | array of string | No       | at least 1 items, at most 100 items               | -           |
| `signInMethods`          | object or null  | No       | -                                                 | -           |
| `signInMethods.allowed`  | array of string | No       | at least 1 items, at most 15 items, no duplicates | -           |
| `requireSso`             | boolean         | No       | -                                                 | -           |
| `connectedApps`          | object or null  | No       | -                                                 | -           |
| `connectedApps.mode`     | string          | No       | one of `"approved"`, `"none"`                     | -           |
| `connectedApps.approved` | array of string | No       | at most 50 items, no duplicates                   | -           |
| `outsiders`              | object or null  | No       | -                                                 | -           |
| `outsiders.mode`         | string          | No       | one of `"limited"`, `"blocked"`                   | -           |
| `outsiders.maxRole`      | string          | No       | one of `"editor"`, `"viewer"`                     | -           |
| `appTeamSessions`        | string or null  | No       | one of `"refused"`                                | -           |
| `expectedUpdatedAt`      | string or null  | No       | at most 64 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/policy/workspaces/YOUR_TARGET_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "idleMinutes": 0,
  "maxSessionHours": 0,
  "ipAllowlist": {
    "ranges": [
      "string"
    ]
  }
}'
```

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

## Responses

### 200 OK

OK

```json title="Example"
{
  "affected": {
    "people": 4,
    "sessions": 4
  },
  "effective": {
    "appTeamSessions": "refused",
    "connectedApps": {
      "approved": ["WIiFoauI7pn0ZclQHOi5Tvp0MrCIf98J5SaplEbA"],
      "mode": "approved"
    },
    "idleMinutes": 15,
    "ipAllowlist": {
      "company": ["10.20.0.0/16", "127.0.0.0/8", "::1/128"],
      "workspace": ["10.20.5.0/24"]
    },
    "maxSessionHours": 8,
    "outsiders": {
      "maxRole": "viewer",
      "mode": "blocked"
    },
    "requireSso": true,
    "signInMethods": ["passkey"]
  },
  "rules": {
    "appTeamSessions": "refused",
    "connectedApps": {
      "approved": ["WIiFoauI7pn0ZclQHOi5Tvp0MrCIf98J5SaplEbA"],
      "mode": "approved"
    },
    "idleMinutes": 15,
    "ipAllowlist": {
      "ranges": ["10.20.5.0/24"]
    },
    "maxSessionHours": 8,
    "outsiders": {
      "maxRole": "viewer",
      "mode": "blocked"
    },
    "requireSso": true,
    "signInMethods": {
      "allowed": ["passkey"]
    },
    "workspaceId": "000000000000000000000001"
  },
  "sameAsCompany": [],
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": "Session User wsrules-ada",
  "warnings": [],
  "workspace": "Globex finance 1767225600000",
  "workspaceId": "000000000000000000000001"
}
```

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