Skip to main content
API docs by Redocly

Ory Oathkeeper API

Download OpenAPI specification:Download

E-mail: hi@ory.sh License: Apache 2.0

Documentation for all of Ory Oathkeeper's APIs.

api

Lists Cryptographic Keys

This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Access Control Decision API

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.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "details": [
    ],
  • "message": "string",
  • "reason": "string",
  • "request": "string",
  • "status": "string"
}

List All Rules

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.

query Parameters
limit
integer <int64>

The maximum amount of rules returned.

offset
integer <int64>

The offset from where to start looking.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a Rule

Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "authenticators": [
    ],
  • "authorizer": {
    },
  • "description": "string",
  • "id": "string",
  • "match": {
    },
  • "mutators": [
    ],
  • "upstream": {
    }
}

metadata

Check HTTP Server Status

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.

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Check HTTP Server and Database Status

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.

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Return Running Software Version.

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.

Responses

Response samples

Content type
application/json
{
  • "version": "string"
}