# Update a workload credential

Needs company access keys at manage.

`PATCH /api/v1/public/workspaces/workspaceId/enterprise/workload-identity/credentials/credentialId`

- 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 `keys` at `manage`. A change that widens it (turning it on, issuer, audience, pins, scopes, lifetimes or ranges) also needs a recent re-authentication (403 `reauth_required`); turning it off, renaming and narrowing do not.

## Request

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

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

| Field                 | Type            | Required | Constraints                        | Description |
| --------------------- | --------------- | -------- | ---------------------------------- | ----------- |
| `name`                | string          | No       | 1 to 80 characters                 | -           |
| `issuer`              | string          | No       | at most 512 characters             | -           |
| `audience`            | string          | No       | at most 256 characters             | -           |
| `subject`             | object or null  | No       | -                                  | -           |
| `subject.value`       | string          | No       | at most 256 characters             | -           |
| `subject.prefix`      | boolean         | No       | -                                  | -           |
| `conditions`          | array of object | No       | at most 10 items                   | -           |
| `conditions[].claim`  | string          | No       | at most 64 characters              | -           |
| `conditions[].value`  | string          | No       | at most 256 characters             | -           |
| `labels`              | object          | No       | -                                  | -           |
| `scopes`              | array of string | No       | at least 1 items, at most 15 items | -           |
| `tokenMinutes`        | integer         | No       | one of `5`, `15`, `30`, `60`       | -           |
| `maxAssertionMinutes` | integer         | No       | at least 1, at most 1440           | -           |
| `ipRanges`            | array of string | No       | at most 20 items                   | -           |
| `status`              | string          | No       | one of `"active"`, `"disabled"`    | -           |
| `endLiveTokens`       | boolean         | No       | -                                  | -           |

## 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/workload-identity/credentials/YOUR_CREDENTIAL_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "issuer": "string",
  "audience": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workload-identity/credentials/YOUR_CREDENTIAL_ID',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      issuer: 'string',
      audience: '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.patch(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workload-identity/credentials/YOUR_CREDENTIAL_ID",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "issuer": "string",
        "audience": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "audience": "http://localhost:3000/org/000000000000000000000001",
  "conditions": [
    {
      "claim": "repository_owner_id",
      "value": "1001"
    },
    {
      "claim": "repository_id",
      "value": "456789"
    },
    {
      "claim": "ref",
      "value": "refs/heads/main"
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdVia": "console",
  "credentialId": "YbQkOkfBRflQ1d47",
  "ipRanges": [],
  "issuer": "https://token.actions.githubusercontent.com",
  "keys": {
    "checkedAt": "[REDACTED]",
    "count": 0,
    "error": null
  },
  "labels": {
    "owner": "globex-eng",
    "repository": "deploy"
  },
  "lastRefusal": {
    "at": "2026-01-01T00:00:00.000Z",
    "claim": "repository_owner_id",
    "reason": "conditions_not_met"
  },
  "lastUsedAt": null,
  "liveTokens": 0,
  "maxAssertionMinutes": 60,
  "name": "wide retarget 1767225600000",
  "preset": "github_actions",
  "reference": "bbwi_6af413602865c46d9a5f7511_YbQkOkfBRflQ1d47",
  "reusableTokens": false,
  "scopes": ["audit:read"],
  "serviceAccount": "deploy-bot",
  "serviceAccountId": "000000000000000000000002",
  "status": "active",
  "subject": null,
  "tokenMinutes": 0
}
```

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