Skip to main content

Portal Access

GET 
/v1/auth/portal-access

200 iff the calling session holds docs:read_{tier}; 401 with no session at all; 403 with a session that lacks the tier's role.

tier=public is the one exception: it requires a session (401 without one, same as every other tier) but no permission beyond that, so it can never return 403. See this module's docstring for why that is a real tier here rather than a docs:read_public catalog entry.

Request​

Responses​

Successful Response

Response Headers
    RateLimit

    Current tenant quota state (draft-ietf-httpapi-ratelimit-headers structured field): "tenant";r=<remaining>;t=<seconds-to-reset>. Emitted on every response when per-tenant rate limiting is enabled (ARMOR_TENANT_RATE_LIMIT_PER_MIN > 0; off by default).

    RateLimit-Policy

    The quota policy the RateLimit header reports against: "tenant";q=<limit>;w=<window-seconds>.

    X-Correlation-Id

    Request correlation id — present on every response; quote it when reporting an issue. Error bodies carry the same value as correlation_id.

Was this helpful?

Optional comments unlock after a short time on this docs site.

Ask the docs

Tier-scoped answers from this portal corpus (extractive; no external LLM).

Comments

Loading comments…

Suggest an edit

Propose a correction. Staff review every suggestion and open a draft PR; nothing publishes without CI.