# List the company's workload credentials and exchange details

Needs company access keys at view.

`GET /api/v1/public/workspaces/workspaceId/enterprise/workload-identity`

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

Needs company access `keys` at `view`. Narrow it to one service account with `serviceAccountId`.

## Request

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

## 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 GET "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workload-identity" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workload-identity',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
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.get(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workload-identity",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "audience": "http://localhost:3000/org/000000000000000000000001",
  "available": true,
  "credentials": [
    {
      "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": "app",
      "credentialId": "MYnnTRfErf6iyHdh",
      "ipRanges": [],
      "issuer": "https://token.actions.githubusercontent.com",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {
        "owner": "globex-eng",
        "repository": "deploy"
      },
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 60,
      "name": "deploy",
      "preset": "github_actions",
      "reference": "bbwi_6af413602865c46d9a5f7511_MYnnTRfErf6iyHdh",
      "reusableTokens": false,
      "scopes": ["audit:read", "people:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": null,
      "tokenMinutes": 0
    },
    {
      "audience": "http://localhost:3000/org/000000000000000000000001",
      "conditions": [
        {
          "claim": "namespace_id",
          "value": "77"
        },
        {
          "claim": "project_id",
          "value": "4242"
        },
        {
          "claim": "ref",
          "value": "main"
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "console",
      "credentialId": "ihmeH0Zi6vcQ4O8B",
      "ipRanges": [],
      "issuer": "https://gitlab.com",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {},
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 60,
      "name": "GitLab 1767225600000",
      "preset": "gitlab",
      "reference": "bbwi_6af413602865c46d9a5f7511_ihmeH0Zi6vcQ4O8B",
      "reusableTokens": false,
      "scopes": ["audit:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": null,
      "tokenMinutes": 0
    },
    {
      "audience": "http://localhost:3000/org/000000000000000000000001",
      "conditions": [
        {
          "claim": "email",
          "value": "user@example.com"
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "console",
      "credentialId": "qJarPaHBxlpZwHZg",
      "ipRanges": [],
      "issuer": "https://accounts.google.com",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {},
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 60,
      "name": "Google Cloud 1767225600000",
      "preset": "google_cloud",
      "reference": "bbwi_6af413602865c46d9a5f7511_qJarPaHBxlpZwHZg",
      "reusableTokens": true,
      "scopes": ["audit:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": {
        "prefix": false,
        "value": "112233445566778899000"
      },
      "tokenMinutes": 0
    },
    {
      "audience": "http://localhost:3000/org/000000000000000000000001",
      "conditions": [],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "console",
      "credentialId": "DDOMbg5ZTu4i8JOu",
      "ipRanges": [],
      "issuer": "https://m21stub0000.tokens.sts.global.api.aws",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {},
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 60,
      "name": "AWS 1767225600000",
      "preset": "aws",
      "reference": "bbwi_6af413602865c46d9a5f7511_DDOMbg5ZTu4i8JOu",
      "reusableTokens": false,
      "scopes": ["audit:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": {
        "prefix": false,
        "value": "arn:aws:iam::123456789012:role/deploy"
      },
      "tokenMinutes": 0
    },
    {
      "audience": "http://localhost:3000/org/000000000000000000000001",
      "conditions": [
        {
          "claim": "tid",
          "value": "00000000-0000-4000-8000-000000000001"
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "console",
      "credentialId": "JE5YjMtWPx842MUs",
      "ipRanges": [],
      "issuer": "https://login.microsoftonline.com/7c7f1a7e-2b4e-4d65-9a1f-3c1a2b3c4d5e/v2.0",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {},
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 1440,
      "name": "Microsoft Entra 1767225600000",
      "preset": "entra",
      "reference": "bbwi_6af413602865c46d9a5f7511_JE5YjMtWPx842MUs",
      "reusableTokens": true,
      "scopes": ["audit:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": {
        "prefix": false,
        "value": "00000000-0000-4000-8000-000000000002"
      },
      "tokenMinutes": 0
    },
    {
      "audience": "http://localhost:3000/org/000000000000000000000001",
      "conditions": [],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "console",
      "credentialId": "T84jX1lSWxzh0cgo",
      "ipRanges": [],
      "issuer": "http://127.0.0.1:4199/ci/custom/buildfarm",
      "keys": {
        "checkedAt": "[REDACTED]",
        "count": 0,
        "error": null
      },
      "labels": {},
      "lastRefusal": null,
      "lastUsedAt": null,
      "liveTokens": 0,
      "maxAssertionMinutes": 60,
      "name": "another OIDC issuer 1767225600000",
      "preset": "custom",
      "reference": "bbwi_6af413602865c46d9a5f7511_T84jX1lSWxzh0cgo",
      "reusableTokens": false,
      "scopes": ["audit:read"],
      "serviceAccount": "deploy-bot",
      "serviceAccountId": "000000000000000000000002",
      "status": "active",
      "subject": {
        "prefix": false,
        "value": "system:serviceaccount:ci:deploy"
      },
      "tokenMinutes": 0
    }
  ],
  "max": {
    "perCompany": 100,
    "perServiceAccount": 20
  },
  "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.

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