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 project:
- API version: v0.40.4
- Package version: v0.40.4
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.ory.am
Installation
Build a gem
To build the Ruby code into a gem:
gem build ory-oathkeeper-client.gemspec
Then either install the gem locally:
gem install ./ory-oathkeeper-client-v0.40.4.gem
(for development, run gem install --dev ./ory-oathkeeper-client-v0.40.4.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'ory-oathkeeper-client', '~> v0.40.4'
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:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# 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 | GET /decisions | Access Control Decision API |
OryOathkeeperClient::ApiApi | get_rule | GET /rules/id | Retrieve a Rule |
OryOathkeeperClient::ApiApi | get_well_known_json_web_keys | GET /.well-known/jwks.json | Lists Cryptographic Keys |
OryOathkeeperClient::ApiApi | list_rules | GET /rules | List All Rules |
OryOathkeeperClient::HealthApi | is_instance_alive | GET /health/alive | Check alive status |
OryOathkeeperClient::HealthApi | is_instance_ready | GET /health/ready | Check readiness status |
OryOathkeeperClient::VersionApi | get_version | GET /version | Get service version |
Documentation for Models
- OryOathkeeperClient::GenericError
- OryOathkeeperClient::HealthNotReadyStatus
- OryOathkeeperClient::HealthStatus
- OryOathkeeperClient::JsonWebKey
- OryOathkeeperClient::JsonWebKeySet
- OryOathkeeperClient::Rule
- OryOathkeeperClient::RuleHandler
- OryOathkeeperClient::RuleMatch
- OryOathkeeperClient::Upstream
- OryOathkeeperClient::Version
Documentation for Authorization
All endpoints do not require authorization.