# Turn agent access on or off, or change its token lifetime

Needs the setup area at manage; turning it on also needs a recent sign-in (403 reauth_required).

`PATCH /api/v1/public/workspaces/workspaceId/enterprise/agent-access`

- 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 `setup` area at `manage`; turning it on also needs a recent sign-in (403 `reauth_required`). Turning it off ends the sessions of every agent it approved. 409 `agent_access_off` when the app's team has not turned it on, 409 `agent_issuer_taken` when another company holds the issuer.

## Request

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

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

| Field          | Type    | Required | Constraints                     | Description |
| -------------- | ------- | -------- | ------------------------------- | ----------- |
| `status`       | string  | No       | one of `"active"`, `"disabled"` | -           |
| `tokenMinutes` | integer | No       | one of `5`, `15`, `30`, `60`    | -           |

## 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 PATCH "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active",
  "tokenMinutes": 5
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      status: 'active',
      tokenMinutes: 5,
    }),
  }
);
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.patch(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "status": "active",
        "tokenMinutes": 5,
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "agents": {
    "allowed": [
      {
        "clientId": "IIDobjbV4HB0tQDo1lRHNhprt7IGGKR6uxp2qi3Y",
        "identifiedBy": "registered",
        "title": "Second agent 1767225600000"
      },
      {
        "clientId": "3WeDmRQJI9oZrANqfrUwm392oaw3JX1yHviXwqhq",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "clientId": "pjUaF40O2rtm64dBqY0cTfKTNhlqU1P8bVdZycha",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "clientId": "JqaLEW6YTfKbcERm1VrodxwoW7AzlvEMSduwLoQC",
        "identifiedBy": "registered",
        "title": "Second agent 1767225600000"
      },
      {
        "clientId": "VXsk3VwZodEHrA6UT9OJFZ1TuzgO4t2ON88hwYDb",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "clientId": "L4trnsJReCyjyIZQMScvU0ty6eHA4Af1aMDb8nbT",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "clientId": "0KMHGQRzsdUyyxIy0QL6vLQaiUElpWWylys1a6Bd",
        "identifiedBy": "registered",
        "title": "M17 agent 1767225600000"
      },
      {
        "clientId": "ePJlBwmsp0AKQFNLy29YYiT6OpgwJMZqZeG7m8uv",
        "identifiedBy": "registered",
        "title": "M17 agent 1767225600000"
      },
      {
        "clientId": "nysUGAyOW12ixNsman6ebx10ZcMKMOxMmupN0meb",
        "identifiedBy": "registered",
        "title": "M10 agent 1767225600000"
      },
      {
        "clientId": "rIG6JB0QlxdkVeRMnrTM0M3VCKXw394eUerQ8u83",
        "identifiedBy": "registered",
        "title": "MCP Discovery Client"
      }
    ],
    "mode": "any"
  },
  "audience": "http://localhost:3000/org/000000000000000000000001",
  "available": true,
  "connections": [
    {
      "isDefault": true,
      "label": "Okta",
      "ref": "52eb7c252b79bbbb"
    }
  ],
  "issuer": {
    "addedAt": "2026-01-01T00:00:00.000Z",
    "addedBy": "The app's team",
    "advertisesIdJag": true,
    "connection": {
      "label": "Okta",
      "ref": "52eb7c252b79bbbb"
    },
    "issuer": "http://127.0.0.1:4199/idp/globex",
    "jwksUri": "http://127.0.0.1:4199/idp/globex/keys",
    "jwksUriOverridden": false,
    "keys": {
      "checkedAt": "[REDACTED]",
      "count": 0,
      "error": null
    },
    "lastUsedAt": "2026-01-01T00:00:00.000Z",
    "notice": null,
    "proof": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": "app_team"
    },
    "status": "disabled",
    "tenant": null,
    "tokenMinutes": 0
  },
  "maxTokenMinutes": 0,
  "provider": "okta",
  "sessionsEnded": 2,
  "tokenEndpoint": "[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.

```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
}
```

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