ory-oathkeeper-client 0.0.0.alpha38

data/docs/SwaggerJSONWebKeySet.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::SwaggerJSONWebKeySet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | [**Array<SwaggerJSONWebKey>**](SwaggerJSONWebKey.md) | The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerJSONWebKeySet.new(
+  keys: null
+)
+```
+

data/docs/SwaggerListRulesParameters.md

@@ -0,0 +1,20 @@
+# OryOathkeeperClient::SwaggerListRulesParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The maximum amount of rules returned. in: query | [optional] |
+| **offset** | **Integer** | The offset from where to start looking. in: query | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerListRulesParameters.new(
+  limit: null,
+  offset: null
+)
+```
+

data/docs/SwaggerNotReadyStatus.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::SwaggerNotReadyStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerNotReadyStatus.new(
+  errors: null
+)
+```
+

data/docs/SwaggerRule.md

@@ -0,0 +1,30 @@
+# OryOathkeeperClient::SwaggerRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] |
+| **authorizer** | [**SwaggerRuleHandler**](SwaggerRuleHandler.md) |  | [optional] |
+| **description** | **String** | Description is a human readable description of this rule. | [optional] |
+| **id** | **String** | ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule. | [optional] |
+| **match** | [**SwaggerRuleMatch**](SwaggerRuleMatch.md) |  | [optional] |
+| **mutators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] |
+| **upstream** | [**Upstream**](Upstream.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerRule.new(
+  authenticators: null,
+  authorizer: null,
+  description: null,
+  id: null,
+  match: null,
+  mutators: null,
+  upstream: null
+)
+```
+

data/docs/SwaggerRuleHandler.md

@@ -0,0 +1,20 @@
+# OryOathkeeperClient::SwaggerRuleHandler
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Object** | Config contains the configuration for the handler. Please read the user guide for a complete list of each handler's available settings. | [optional] |
+| **handler** | **String** | Handler identifies the implementation which will be used to handle this specific request. Please read the user guide for a complete list of available handlers. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerRuleHandler.new(
+  config: null,
+  handler: null
+)
+```
+

data/docs/SwaggerRuleMatch.md

@@ -0,0 +1,20 @@
+# OryOathkeeperClient::SwaggerRuleMatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **methods** | **Array<String>** | An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match. | [optional] |
+| **url** | **String** | This field represents the URL pattern this rule matches. When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the full request URL (e.g. https://mydomain.com/api/resource) without query parameters of the incoming request with this field. If a match is found, the rule is considered a partial match. If the matchesMethods field is satisfied as well, the rule is considered a full match.  You can use regular expressions in this field to match more than one url. Regular expressions are encapsulated in brackets < and >. The following example matches all paths of the domain `mydomain.com`: `https://mydomain.com/<.*>`. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerRuleMatch.new(
+  methods: null,
+  url: null
+)
+```
+

data/docs/SwaggerRuleResponse.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::SwaggerRuleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerRuleResponse.new(
+  body: null
+)
+```
+

data/docs/SwaggerRulesResponse.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::SwaggerRulesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**Array<SwaggerRule>**](SwaggerRule.md) | in: body type: array | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerRulesResponse.new(
+  body: null
+)
+```
+

data/docs/SwaggerUpdateRuleParameters.md

@@ -0,0 +1,20 @@
+# OryOathkeeperClient::SwaggerUpdateRuleParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
+| **id** | **String** | in: path |  |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerUpdateRuleParameters.new(
+  body: null,
+  id: null
+)
+```
+

data/docs/SwaggerVersion.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::SwaggerVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::SwaggerVersion.new(
+  version: null
+)
+```
+

data/docs/UpdateRuleForbidden.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::UpdateRuleForbidden
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleForbiddenBody**](UpdateRuleForbiddenBody.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleForbidden.new(
+  payload: null
+)
+```
+

data/docs/UpdateRuleForbiddenBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::UpdateRuleForbiddenBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleForbiddenBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/UpdateRuleInternalServerError.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::UpdateRuleInternalServerError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleInternalServerErrorBody**](UpdateRuleInternalServerErrorBody.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleInternalServerError.new(
+  payload: null
+)
+```
+

data/docs/UpdateRuleInternalServerErrorBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::UpdateRuleInternalServerErrorBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleInternalServerErrorBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/UpdateRuleNotFound.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::UpdateRuleNotFound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleNotFoundBody**](UpdateRuleNotFoundBody.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleNotFound.new(
+  payload: null
+)
+```
+

data/docs/UpdateRuleNotFoundBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::UpdateRuleNotFoundBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleNotFoundBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/UpdateRuleOK.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::UpdateRuleOK
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleOK.new(
+  payload: null
+)
+```
+

data/docs/UpdateRuleUnauthorized.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::UpdateRuleUnauthorized
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleUnauthorizedBody**](UpdateRuleUnauthorizedBody.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleUnauthorized.new(
+  payload: null
+)
+```
+

data/docs/UpdateRuleUnauthorizedBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::UpdateRuleUnauthorizedBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::UpdateRuleUnauthorizedBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/Upstream.md

@@ -0,0 +1,22 @@
+# OryOathkeeperClient::Upstream
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preserve_host** | **Boolean** | PreserveHost, if false (the default), tells ORY Oathkeeper to set the upstream request's Host header to the hostname of the API's upstream's URL. Setting this flag to true instructs ORY Oathkeeper not to do so. | [optional] |
+| **strip_path** | **String** | StripPath if set, replaces the provided path prefix when forwarding the requested URL to the upstream URL. | [optional] |
+| **url** | **String** | URL is the URL the request will be proxied to. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::Upstream.new(
+  preserve_host: null,
+  strip_path: null,
+  url: null
+)
+```
+