# ory-oathkeeper-client

OryOathkeeperClient - the Ruby gem for the ORY Oathkeeper

ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validity against a set of rules. This service uses Hydra to validate access tokens and policies.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v0.0.0-alpha.48
- Package version: v0.0.0-alpha.48
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://www.ory.am](https://www.ory.am)

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build ory-oathkeeper-client.gemspec
```

Then either install the gem locally:

```shell
gem install ./ory-oathkeeper-client-v0.0.0-alpha.48.gem
```

(for development, run `gem install --dev ./ory-oathkeeper-client-v0.0.0-alpha.48.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'ory-oathkeeper-client', '~> v0.0.0-alpha.48'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/ory/sdk, then add the following in the Gemfile:

    gem 'ory-oathkeeper-client', :git => 'https://github.com/ory/sdk.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'ory-oathkeeper-client'

api_instance = OryOathkeeperClient::ApiApi.new

begin
  #Access Control Decision API
  api_instance.decisions
rescue OryOathkeeperClient::ApiError => e
  puts "Exception when calling ApiApi->decisions: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*OryOathkeeperClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
*OryOathkeeperClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
*OryOathkeeperClient::ApiApi* | [**get_version**](docs/ApiApi.md#get_version) | **GET** /version | Get service version
*OryOathkeeperClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
*OryOathkeeperClient::ApiApi* | [**is_instance_alive**](docs/ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
*OryOathkeeperClient::ApiApi* | [**is_instance_ready**](docs/ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
*OryOathkeeperClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules


## Documentation for Models

 - [OryOathkeeperClient::CreateRuleCreated](docs/CreateRuleCreated.md)
 - [OryOathkeeperClient::CreateRuleForbidden](docs/CreateRuleForbidden.md)
 - [OryOathkeeperClient::CreateRuleForbiddenBody](docs/CreateRuleForbiddenBody.md)
 - [OryOathkeeperClient::CreateRuleInternalServerError](docs/CreateRuleInternalServerError.md)
 - [OryOathkeeperClient::CreateRuleInternalServerErrorBody](docs/CreateRuleInternalServerErrorBody.md)
 - [OryOathkeeperClient::CreateRuleUnauthorized](docs/CreateRuleUnauthorized.md)
 - [OryOathkeeperClient::CreateRuleUnauthorizedBody](docs/CreateRuleUnauthorizedBody.md)
 - [OryOathkeeperClient::DecisionsForbidden](docs/DecisionsForbidden.md)
 - [OryOathkeeperClient::DecisionsForbiddenBody](docs/DecisionsForbiddenBody.md)
 - [OryOathkeeperClient::DecisionsInternalServerError](docs/DecisionsInternalServerError.md)
 - [OryOathkeeperClient::DecisionsInternalServerErrorBody](docs/DecisionsInternalServerErrorBody.md)
 - [OryOathkeeperClient::DecisionsNotFound](docs/DecisionsNotFound.md)
 - [OryOathkeeperClient::DecisionsNotFoundBody](docs/DecisionsNotFoundBody.md)
 - [OryOathkeeperClient::DecisionsUnauthorized](docs/DecisionsUnauthorized.md)
 - [OryOathkeeperClient::DecisionsUnauthorizedBody](docs/DecisionsUnauthorizedBody.md)
 - [OryOathkeeperClient::DeleteRuleForbidden](docs/DeleteRuleForbidden.md)
 - [OryOathkeeperClient::DeleteRuleForbiddenBody](docs/DeleteRuleForbiddenBody.md)
 - [OryOathkeeperClient::DeleteRuleInternalServerError](docs/DeleteRuleInternalServerError.md)
 - [OryOathkeeperClient::DeleteRuleInternalServerErrorBody](docs/DeleteRuleInternalServerErrorBody.md)
 - [OryOathkeeperClient::DeleteRuleNotFound](docs/DeleteRuleNotFound.md)
 - [OryOathkeeperClient::DeleteRuleNotFoundBody](docs/DeleteRuleNotFoundBody.md)
 - [OryOathkeeperClient::DeleteRuleUnauthorized](docs/DeleteRuleUnauthorized.md)
 - [OryOathkeeperClient::DeleteRuleUnauthorizedBody](docs/DeleteRuleUnauthorizedBody.md)
 - [OryOathkeeperClient::GetRuleForbidden](docs/GetRuleForbidden.md)
 - [OryOathkeeperClient::GetRuleForbiddenBody](docs/GetRuleForbiddenBody.md)
 - [OryOathkeeperClient::GetRuleInternalServerError](docs/GetRuleInternalServerError.md)
 - [OryOathkeeperClient::GetRuleInternalServerErrorBody](docs/GetRuleInternalServerErrorBody.md)
 - [OryOathkeeperClient::GetRuleNotFound](docs/GetRuleNotFound.md)
 - [OryOathkeeperClient::GetRuleNotFoundBody](docs/GetRuleNotFoundBody.md)
 - [OryOathkeeperClient::GetRuleOK](docs/GetRuleOK.md)
 - [OryOathkeeperClient::GetRuleUnauthorized](docs/GetRuleUnauthorized.md)
 - [OryOathkeeperClient::GetRuleUnauthorizedBody](docs/GetRuleUnauthorizedBody.md)
 - [OryOathkeeperClient::GetWellKnownForbidden](docs/GetWellKnownForbidden.md)
 - [OryOathkeeperClient::GetWellKnownForbiddenBody](docs/GetWellKnownForbiddenBody.md)
 - [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerError](docs/GetWellKnownJSONWebKeysInternalServerError.md)
 - [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerErrorBody](docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md)
 - [OryOathkeeperClient::GetWellKnownJSONWebKeysOK](docs/GetWellKnownJSONWebKeysOK.md)
 - [OryOathkeeperClient::GetWellKnownOK](docs/GetWellKnownOK.md)
 - [OryOathkeeperClient::GetWellKnownUnauthorized](docs/GetWellKnownUnauthorized.md)
 - [OryOathkeeperClient::GetWellKnownUnauthorizedBody](docs/GetWellKnownUnauthorizedBody.md)
 - [OryOathkeeperClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
 - [OryOathkeeperClient::HealthStatus](docs/HealthStatus.md)
 - [OryOathkeeperClient::InlineResponse500](docs/InlineResponse500.md)
 - [OryOathkeeperClient::IsInstanceAliveInternalServerError](docs/IsInstanceAliveInternalServerError.md)
 - [OryOathkeeperClient::IsInstanceAliveInternalServerErrorBody](docs/IsInstanceAliveInternalServerErrorBody.md)
 - [OryOathkeeperClient::IsInstanceAliveOK](docs/IsInstanceAliveOK.md)
 - [OryOathkeeperClient::JsonWebKey](docs/JsonWebKey.md)
 - [OryOathkeeperClient::JsonWebKeySet](docs/JsonWebKeySet.md)
 - [OryOathkeeperClient::JudgeForbidden](docs/JudgeForbidden.md)
 - [OryOathkeeperClient::JudgeForbiddenBody](docs/JudgeForbiddenBody.md)
 - [OryOathkeeperClient::JudgeInternalServerError](docs/JudgeInternalServerError.md)
 - [OryOathkeeperClient::JudgeInternalServerErrorBody](docs/JudgeInternalServerErrorBody.md)
 - [OryOathkeeperClient::JudgeNotFound](docs/JudgeNotFound.md)
 - [OryOathkeeperClient::JudgeNotFoundBody](docs/JudgeNotFoundBody.md)
 - [OryOathkeeperClient::JudgeUnauthorized](docs/JudgeUnauthorized.md)
 - [OryOathkeeperClient::JudgeUnauthorizedBody](docs/JudgeUnauthorizedBody.md)
 - [OryOathkeeperClient::ListRulesForbidden](docs/ListRulesForbidden.md)
 - [OryOathkeeperClient::ListRulesForbiddenBody](docs/ListRulesForbiddenBody.md)
 - [OryOathkeeperClient::ListRulesInternalServerError](docs/ListRulesInternalServerError.md)
 - [OryOathkeeperClient::ListRulesInternalServerErrorBody](docs/ListRulesInternalServerErrorBody.md)
 - [OryOathkeeperClient::ListRulesOK](docs/ListRulesOK.md)
 - [OryOathkeeperClient::ListRulesUnauthorized](docs/ListRulesUnauthorized.md)
 - [OryOathkeeperClient::ListRulesUnauthorizedBody](docs/ListRulesUnauthorizedBody.md)
 - [OryOathkeeperClient::Rule](docs/Rule.md)
 - [OryOathkeeperClient::RuleHandler](docs/RuleHandler.md)
 - [OryOathkeeperClient::RuleMatch](docs/RuleMatch.md)
 - [OryOathkeeperClient::SwaggerCreateRuleParameters](docs/SwaggerCreateRuleParameters.md)
 - [OryOathkeeperClient::SwaggerGetRuleParameters](docs/SwaggerGetRuleParameters.md)
 - [OryOathkeeperClient::SwaggerHealthStatus](docs/SwaggerHealthStatus.md)
 - [OryOathkeeperClient::SwaggerJSONWebKey](docs/SwaggerJSONWebKey.md)
 - [OryOathkeeperClient::SwaggerJSONWebKeySet](docs/SwaggerJSONWebKeySet.md)
 - [OryOathkeeperClient::SwaggerListRulesParameters](docs/SwaggerListRulesParameters.md)
 - [OryOathkeeperClient::SwaggerNotReadyStatus](docs/SwaggerNotReadyStatus.md)
 - [OryOathkeeperClient::SwaggerRule](docs/SwaggerRule.md)
 - [OryOathkeeperClient::SwaggerRuleHandler](docs/SwaggerRuleHandler.md)
 - [OryOathkeeperClient::SwaggerRuleMatch](docs/SwaggerRuleMatch.md)
 - [OryOathkeeperClient::SwaggerRuleResponse](docs/SwaggerRuleResponse.md)
 - [OryOathkeeperClient::SwaggerRulesResponse](docs/SwaggerRulesResponse.md)
 - [OryOathkeeperClient::SwaggerUpdateRuleParameters](docs/SwaggerUpdateRuleParameters.md)
 - [OryOathkeeperClient::SwaggerVersion](docs/SwaggerVersion.md)
 - [OryOathkeeperClient::UpdateRuleForbidden](docs/UpdateRuleForbidden.md)
 - [OryOathkeeperClient::UpdateRuleForbiddenBody](docs/UpdateRuleForbiddenBody.md)
 - [OryOathkeeperClient::UpdateRuleInternalServerError](docs/UpdateRuleInternalServerError.md)
 - [OryOathkeeperClient::UpdateRuleInternalServerErrorBody](docs/UpdateRuleInternalServerErrorBody.md)
 - [OryOathkeeperClient::UpdateRuleNotFound](docs/UpdateRuleNotFound.md)
 - [OryOathkeeperClient::UpdateRuleNotFoundBody](docs/UpdateRuleNotFoundBody.md)
 - [OryOathkeeperClient::UpdateRuleOK](docs/UpdateRuleOK.md)
 - [OryOathkeeperClient::UpdateRuleUnauthorized](docs/UpdateRuleUnauthorized.md)
 - [OryOathkeeperClient::UpdateRuleUnauthorizedBody](docs/UpdateRuleUnauthorizedBody.md)
 - [OryOathkeeperClient::Upstream](docs/Upstream.md)
 - [OryOathkeeperClient::Version](docs/Version.md)


## Documentation for Authorization

 All endpoints do not require authorization.