Skip to main content

Local Admin Impersonate

POST 
/auth/local-admin/impersonate

Set (or change) the tenant + role this local admin session presents as everywhere else in the API. Callable repeatedly to switch tenant/role without a fresh login -- each call fully replaces the prior target.

Request​

Responses​

Successful Response

Response Headers
    Idempotency-Replayed

    true when this response was replayed from the idempotency cache for a repeated Idempotency-Key instead of re-executing.

    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.