openapi: 3.1.0 info: title: Metrics OAuth2 Proxy Endpoints API description: 'HTTP endpoints exposed by oauth2-proxy, a reverse proxy that authenticates requests using upstream OAuth/OIDC providers. The OAuth2 endpoints live under a configurable prefix (`--proxy-prefix`, default `/oauth2`); the health and operational endpoints live at the document root. Sourced from https://oauth2-proxy.github.io/oauth2-proxy/features/endpoints. ' version: '1.0' servers: - url: http://localhost:4180 description: Default oauth2-proxy listen address tags: - name: OAuth2 Proxy Endpoints paths: /: get: summary: Authenticate and proxy to upstream description: Validates the session cookie and proxies authenticated requests to the configured upstream. responses: '200': description: Upstream response is returned to the client. '302': description: Redirected to the sign-in flow when unauthenticated. tags: - OAuth2 Proxy Endpoints components: securitySchemes: SessionCookie: type: apiKey in: cookie name: _oauth2_proxy description: Session cookie established by the OAuth callback.