Oauth2-Proxy

opencollection: 1.0.0
info:
  name: OAuth2 Proxy Endpoints
  version: '1.0'
items:
- info:
    name: Authenticate and proxy to upstream
    type: http
  http:
    method: GET
    url: http://localhost:4180/
  docs: Validates the session cookie and proxies authenticated requests to the configured upstream.
- info:
    name: Robots exclusion
    type: http
  http:
    method: GET
    url: http://localhost:4180/robots.txt
  docs: Robots exclusion
- info:
    name: Liveness probe
    type: http
  http:
    method: GET
    url: http://localhost:4180/ping
  docs: Liveness probe
- info:
    name: Readiness probe
    type: http
  http:
    method: GET
    url: http://localhost:4180/ready
  docs: Verifies underlying connections such as Redis are healthy.
- info:
    name: Prometheus metrics
    type: http
  http:
    method: GET
    url: http://localhost:4180/metrics
  docs: Exposes Prometheus-format metrics when enabled.
- info:
    name: Render sign-in page
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/sign_in
  docs: Render sign-in page
- info:
    name: Clear the session cookie
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/sign_out
  docs: Clears the local session and optionally redirects to the provider's logout endpoint.
- info:
    name: Begin OAuth authorization
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/start
  docs: Begin OAuth authorization
- info:
    name: OAuth callback target
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/callback
  docs: Endpoint the OAuth provider redirects back to after consent.
- info:
    name: External authentication subrequest
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/auth
    auth:
      type: apikey
      key: _oauth2_proxy
      value: '{{_oauth2_proxy}}'
      placement: query
  docs: 'Returns 202 when the request is authenticated and 401 when it is

    not, intended for use with `nginx auth_request` or similar

    gateways.

    '
- info:
    name: Authenticated user information
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/userinfo
    auth:
      type: apikey
      key: _oauth2_proxy
      value: '{{_oauth2_proxy}}'
      placement: query
  docs: Authenticated user information
- info:
    name: Serve static assets for the login/error pages
    type: http
  http:
    method: GET
    url: http://localhost:4180/oauth2/static/:path
    params:
    - name: path
      value: ''
      type: path
  docs: Serve static assets for the login/error pages
bundled: true