Ory

opencollection: 1.0.0
info:
  name: Ory Oathkeeper API
items:
- info:
    name: api
    type: folder
  items:
  - info:
      name: Lists Cryptographic Keys
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/.well-known/jwks.json'
    docs: This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
  - info:
      name: Access Control Decision API
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/decisions'
    docs: '> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decisions.


      This endpoint mirrors the proxy capability of ORY Oathkeeper''s proxy functionality but instead of forwarding the

      request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden)

      status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.'
  - info:
      name: List All Rules
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/rules'
      params:
      - name: limit
        value: ''
        type: query
        description: The maximum amount of rules returned.
      - name: offset
        value: ''
        type: query
        description: The offset from where to start looking.
    docs: 'This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full

      view of what rules you have currently in place.'
  - info:
      name: Retrieve a Rule
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/rules/:id'
      params:
      - name: id
        value: ''
        type: path
    docs: Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
- info:
    name: metadata
    type: folder
  items:
  - info:
      name: Check HTTP Server Status
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/health/alive'
    docs: 'This endpoint returns a HTTP 200 status code when Ory Oathkeeper is accepting incoming

      HTTP requests. This status does currently not include checks whether the database connection is working.


      If the service supports TLS Edge Termination, this endpoint does not require the

      `X-Forwarded-Proto` header to be set.


      Be aware that if you are running multiple nodes of this service, the health status will never

      refer to the cluster state, only to a single instance.'
  - info:
      name: Check HTTP Server and Database Status
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/health/ready'
    docs: 'This endpoint returns a HTTP 200 status code when Ory Oathkeeper is up running and the environment dependencies
      (e.g.

      the database) are responsive as well.


      If the service supports TLS Edge Termination, this endpoint does not require the

      `X-Forwarded-Proto` header to be set.


      Be aware that if you are running multiple nodes of Ory Oathkeeper, the health status will never

      refer to the cluster state, only to a single instance.'
  - info:
      name: Return Running Software Version.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/version'
    docs: 'This endpoint returns the version of Ory Oathkeeper.


      If the service supports TLS Edge Termination, this endpoint does not require the

      `X-Forwarded-Proto` header to be set.


      Be aware that if you are running multiple nodes of this service, the version will never

      refer to the cluster state, only to a single instance.'
bundled: true