Skip to main content

Tenant Roster

GET 
/auth/tenants

Tenant ids + display names for the authenticated principal's roster.

M-CEL E-CEL.2 (login-time cell resolution): each row also carries the tenant's home cell -- resolved (and auto-assigned on first lookup) via tenant_cell_directory.resolve_home_cell() -- plus that cell's region/cloud/api_base_url, so the console SPA can pin subsequent API calls at the tenant's actual home cell (docs/cloud/12-multi-region-and-multi-cloud.md §3, "one login page for everyone"). Best-effort per tenant: a directory hiccup degrades that row's cell fields to None rather than failing the whole roster call -- login must never break because of cell-routing metadata.

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.