Auth API reference

Auth API · Consumer-Agent-Access

get/{app_slug}/v1/agent-access/configAuth

Read this app's agent access settings

Requires `auth.agent_access.configure` on the app.

Path parameters

app_slug*string

The app slug.

Response · 200 The settings (off with empty lists when never set).

enabled*boolean

Agent access is on. While off, discovery is 404 and every protocol endpoint refuses.

resources*array

Resource indicators (RFC 8707) tokens may be minted for: your MCP server URLs. Every token carries exactly one of them in `aud`.

Example: ["https://mcp.example.com/mcp"]

consent_url*string · uri

Your consent page. /authorize redirects the browser here with `?request=<handle>`; the page signs the user in, shows the request and calls approve or deny.

Example: "https://app.example.com/oauth/consent"

scopes*array

The scopes agents can ask for.

Example

Request

GET https://api.auth.productcraft.co/{app_slug}/v1/agent-access/config
Authorization: Bearer YOUR_TOKEN

Response

{
  "enabled": false,
  "resources": [
    "https://mcp.example.com/mcp"
  ],
  "consent_url": "https://app.example.com/oauth/consent",
  "scopes": [
    {
      "name": "disputes:read",
      "description": "Read disputes, transactions and evidence"
    }
  ]
}