Topolo Docs Topolo Platform
Open workspace

List agent access grants

Reads non-revoked grants for this agent. Requires manage_grants access; workspace membership alone is insufficient.

List agent access grants

Outcome

Reads non-revoked grants for this agent. Requires manage_grants access; workspace membership alone is insufficient.

Before you start

  • Verify the intended environment, authenticated identity and organization before discovery.
  • Discover the published agents:read application permission and inspect the credential-scoped action contract.
  • Discover and bind the granted canonical Agent workspace separately from the action input.
  • Fixture identifiers and simulated responses confer no live access. Replace identifiers through granted resource discovery.

Discover the target

  • topolo whoami --json
  • topolo workspaces list topolo-agent --json
  • topolo actions get app_topolo_agent.agents.grants.list --detail --json
  • Read app_topolo_agent.agents.list in this same authorized context and select the returned identifier. Do not derive ids from display names.
  • Inspect app_topolo_agent.agents.get in the same credential and resource context before reading it.

Request

GET /api/agents/{id}/grants

Input fields

FieldRequiredMeaning and constraints
idYesDiscovered resource identifier from app_topolo_agent.agents.list; retain the same organization and workspace context. Type: string. minLength: 1

Worked examples

Worked response 1 · HTTP 200

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "agent_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.agents.grants.list --data @payload.json --json
topolo actions plan app_topolo_agent.agents.grants.list --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_agent.agents.grants.list --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_agent.agents.grants.list",
    "input": {
      "id": "agent_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "success": true,
  "agentId": "agent_docs_fixture",
  "grants": [
    {
      "id": "grant_docs_fixture",
      "agentId": "agent_docs_fixture",
      "targetType": "user",
      "targetId": "usr_reader_fixture",
      "permissions": [
        "discover",
        "view"
      ],
      "createdByPrincipalId": "usr_docs_fixture",
      "createdAt": 1,
      "revokedByPrincipalId": null,
      "revokedAt": null
    }
  ]
}

successful: HTTP 200; seeded local fixture identifiers confer no live access.

Worked response 2 · HTTP 403

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "agent_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.agents.grants.list --data @payload.json --json
topolo actions plan app_topolo_agent.agents.grants.list --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_agent.agents.grants.list",
    "input": {
      "id": "agent_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 403:

{
  "success": false,
  "error": "Insufficient permissions"
}

permission denied: HTTP 403; SDK code permission_denied; seeded local fixture identifiers confer no live access.

Worked response 3 · HTTP 404

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "agent_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.agents.grants.list --data @payload.json --json
topolo actions plan app_topolo_agent.agents.grants.list --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_agent.agents.grants.list",
    "input": {
      "id": "agent_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 404:

{
  "success": false,
  "error": "Agent not found"
}

private resource hidden: HTTP 404; SDK code http_error; seeded local fixture identifiers confer no live access.

Verify the result

  • Confirm agentId, then review targetType, targetId and permissions for every returned grant. The owner and steward can retain access independently of this grant list.

Errors and recovery

  • auth_error (HTTP 401): For an unstructured HTTP 401 response, authenticate and verify the intended organization and workspace before retrying.
  • permission_denied (HTTP 403): For an unstructured HTTP 403 response, use the published application permission and required resource-level access. Do not retry with broader context.
  • http_error (HTTP 404): For an unstructured HTTP 404 response, refresh the corresponding resource listing in the same context. Private resources can be deliberately hidden from this caller.

Authentication, input validation or resource middleware can refuse a request before these handlers. Preserve the actual refusal and request id.

Recovery boundary

This read does not change service state. Re-discover the target in the same authorized organization and workspace after a missing or hidden-resource refusal; do not guess identifiers or widen context.

  • Get agent: Read one agent with its model, persona, service grants, lifecycle state and published version.

Evidence

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.