Sign in
Forward Auth

Evaluate request access for reverse-proxy forward-auth

Use this endpoint from reverse proxies on each request to decide allow, unauthenticated, or forbidden outcomes.

get/v1/forward-auth/check

Request

  • Base URL: https://api.orivis.local
  • URL: https://api.orivis.local/v1/forward-auth/check
  • Auth: one of:
    • API key in cookie orivis_session
    • HTTP bearer

Headers

X-Forwarded-Methodstring required
X-Forwarded-Hoststring required
X-Forwarded-Uristring required
X-Forwarded-Protostring
X-Forwarded-Forstring

Response

Request allowed

decision'allow' | 'deny' | 'unauthenticated' required
reasonCode'allowed' | 'missing_session' | 'user_override_deny' | 'user_override_allow' | 'group_override_deny' | 'group_override_allow' | 'platform_denylist' | 'platform_allowlist_missing' | 'tenant_default_deny' required

Changes

No recorded changes to this operation across all 1 revision of this API.