Skip to content
BuildBase
HTTP API menu

Set the identity provider trusted to approve agents

Needs the setup area at manage, a recent sign-in (403 reauth_required) and the app's plan to include Enterprise SSO (402).

PUT/api/v1/public/workspaces/workspaceId/enterprise/agent-access/issuer

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, a recent sign-in (403 reauth_required) and the app's plan to include Enterprise SSO (402). The issuer's discovery document must name exactly this issuer (400 agent_issuer_invalid); 409 agent_issuer_taken when another company of the app trusts it, 409 agent_access_off.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
workspaceIdstringYes--

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
issuerstringYes1 to 512 characters-
tenantstring or nullNoat most 128 characters-
jwksUristring or nullNoat most 512 characters-
connectionstring or nullNoat most 32 characters-

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X PUT "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access/issuer" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "issuer": "string"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access/issuer',
  {
    method: 'PUT',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      issuer: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import os

import requests

response = requests.put(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/agent-access/issuer",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "issuer": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "agents": {
    "allowed": [
      {
        "clientId": "RBKymkykLTaCklHrX8JHWfrZi4wE2AEiETnQY8Nz",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "clientId": "sZli2BIvqS9UtvsRnmmdRsmwN9wCY1cBNVWHT7Ma",
        "identifiedBy": "registered",
        "title": "M17 agent 1767225600000"
      },
      {
        "clientId": "J2CCTCKFc1vTSP8sEMPbUSUzQ3sXlt2hR2NwMlsQ",
        "identifiedBy": "registered",
        "title": "Okta tester 1767225600000"
      },
      {
        "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"
      }
    ],
    "mode": "any"
  },
  "audience": "http://localhost:3000/org/000000000000000000000001",
  "available": true,
  "connections": [
    {
      "isDefault": true,
      "label": "Okta",
      "ref": "6da1c38316815ce6"
    },
    {
      "isDefault": false,
      "label": "Umbrella (Entra)",
      "ref": "f2a0a3a5254d2007"
    }
  ],
  "issuer": {
    "addedAt": "2026-01-01T00:00:00.000Z",
    "addedBy": "The app's team",
    "advertisesIdJag": true,
    "connection": {
      "label": "Umbrella (Entra)",
      "ref": "f2a0a3a5254d2007"
    },
    "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": "Waiting to be proven. No agent gets a token through it yet. The first time one of your people uses an agent through it and is matched by their single sign-on, the app knows it is your company's and turns it on. The app's team can also approve it.",
    "proof": null,
    "status": "pending",
    "tenant": null,
    "tokenMinutes": 0
  },
  "maxTokenMinutes": 0,
  "provider": "entra",
  "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.

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.

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.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}