ory-oathkeeper-client 0.35.5.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4b89f1f1c1b7ee9f64dd43c843a9421a1421fc93bc521160666167b2e3581fd
+  data.tar.gz: d197a293ad686106c40c24248cb3a2c60fdeb0953f794d8bbdf5f920c9f40b28
+SHA512:
+  metadata.gz: 0fb9dbe0fb1f69087c446ecef708f646aca864ef3e169344a9be009b9fd00f3f2822c03c99c144325d2130abebc434e76695c6494683d8c6a2cb9188018a25d6
+  data.tar.gz: 8b557e5186bb6ce544e03f898ba04fd00e2cd4d9f0d71df6dc24a45c74361e6ed4dc66002dabe05ab197db21d71ac689629b8e7ce0a08810bcf12a6ca3011802

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,103 @@
+# ory-oathkeeper-client
+
+OryHydraClient - 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: Latest
+- Package version: v0.35.5-beta.1
+- 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.35.5-beta.1.gem
+```
+
+(for development, run `gem install --dev ./ory-oathkeeper-client-v0.35.5-beta.1.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.35.5-beta.1'
+
+### 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 = OryHydraClient::ApiApi.new
+
+begin
+  #Access Control Decision API
+  api_instance.decisions
+rescue OryHydraClient::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
+------------ | ------------- | ------------- | -------------
+*OryHydraClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
+*OryHydraClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
+*OryHydraClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
+*OryHydraClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules
+*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
+*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
+*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
+
+
+## Documentation for Models
+
+ - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
+ - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
+ - [OryHydraClient::InlineResponse500](docs/InlineResponse500.md)
+ - [OryHydraClient::JsonWebKey](docs/JsonWebKey.md)
+ - [OryHydraClient::JsonWebKeySet](docs/JsonWebKeySet.md)
+ - [OryHydraClient::Rule](docs/Rule.md)
+ - [OryHydraClient::RuleHandler](docs/RuleHandler.md)
+ - [OryHydraClient::RuleMatch](docs/RuleMatch.md)
+ - [OryHydraClient::Upstream](docs/Upstream.md)
+ - [OryHydraClient::Version](docs/Version.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApiApi.md

@@ -0,0 +1,195 @@
+# OryHydraClient::ApiApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
+[**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
+[**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
+[**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules
+
+
+
+## decisions
+
+> decisions
+
+Access Control Decision API
+
+> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decision.  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.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+
+begin
+  #Access Control Decision API
+  api_instance.decisions
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling ApiApi->decisions: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_rule
+
+> Rule get_rule(id)
+
+Retrieve a rule
+
+Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+id = 'id_example' # String | 
+
+begin
+  #Retrieve a rule
+  result = api_instance.get_rule(id)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling ApiApi->get_rule: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**Rule**](Rule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_well_known_json_web_keys
+
+> JsonWebKeySet get_well_known_json_web_keys
+
+Lists cryptographic keys
+
+This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+
+begin
+  #Lists cryptographic keys
+  result = api_instance.get_well_known_json_web_keys
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling ApiApi->get_well_known_json_web_keys: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_rules
+
+> Array<Rule> list_rules(opts)
+
+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.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+opts = {
+  limit: 56, # Integer | The maximum amount of rules returned.
+  offset: 56 # Integer | The offset from where to start looking.
+}
+
+begin
+  #List all rules
+  result = api_instance.list_rules(opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling ApiApi->list_rules: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The maximum amount of rules returned. | [optional] 
+ **offset** | **Integer**| The offset from where to start looking. | [optional] 
+
+### Return type
+
+[**Array<Rule>**](Rule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CreateRuleCreated.md

@@ -0,0 +1,17 @@
+# OryHydraClient::CreateRuleCreated
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleCreated.new(payload: null)
+```
+
+

data/docs/CreateRuleForbidden.md

@@ -0,0 +1,17 @@
+# OryHydraClient::CreateRuleForbidden
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**CreateRuleForbiddenBody**](CreateRuleForbiddenBody.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleForbidden.new(payload: null)
+```
+
+

data/docs/CreateRuleForbiddenBody.md

@@ -0,0 +1,27 @@
+# OryHydraClient::CreateRuleForbiddenBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | code | [optional] 
+**details** | **Array<Hash<String, Object>>** | details | [optional] 
+**message** | **String** | message | [optional] 
+**reason** | **String** | reason | [optional] 
+**request** | **String** | request | [optional] 
+**status** | **String** | status | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleForbiddenBody.new(code: null,
+                                 details: null,
+                                 message: null,
+                                 reason: null,
+                                 request: null,
+                                 status: null)
+```
+
+

data/docs/CreateRuleInternalServerError.md

@@ -0,0 +1,17 @@
+# OryHydraClient::CreateRuleInternalServerError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**CreateRuleInternalServerErrorBody**](CreateRuleInternalServerErrorBody.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleInternalServerError.new(payload: null)
+```
+
+

data/docs/CreateRuleInternalServerErrorBody.md

@@ -0,0 +1,27 @@
+# OryHydraClient::CreateRuleInternalServerErrorBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | code | [optional] 
+**details** | **Array<Hash<String, Object>>** | details | [optional] 
+**message** | **String** | message | [optional] 
+**reason** | **String** | reason | [optional] 
+**request** | **String** | request | [optional] 
+**status** | **String** | status | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleInternalServerErrorBody.new(code: null,
+                                 details: null,
+                                 message: null,
+                                 reason: null,
+                                 request: null,
+                                 status: null)
+```
+
+

data/docs/CreateRuleUnauthorized.md

@@ -0,0 +1,17 @@
+# OryHydraClient::CreateRuleUnauthorized
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**CreateRuleUnauthorizedBody**](CreateRuleUnauthorizedBody.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRuleUnauthorized.new(payload: null)
+```
+
+