ory-oathkeeper-client 0.0.0.alpha38

data/docs/GetWellKnownUnauthorized.md

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

data/docs/GetWellKnownUnauthorizedBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::GetWellKnownUnauthorizedBody
+
+## 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::GetWellKnownUnauthorizedBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/HealthApi.md

@@ -0,0 +1,96 @@
+# OryHydraClient::HealthApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
+[**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
+
+
+
+## is_instance_alive
+
+> HealthStatus is_instance_alive
+
+Check alive status
+
+This endpoint returns a 200 status code when the HTTP server is up running. 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.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::HealthApi.new
+
+begin
+  #Check alive status
+  result = api_instance.is_instance_alive
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling HealthApi->is_instance_alive: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthStatus**](HealthStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_instance_ready
+
+> HealthStatus is_instance_ready
+
+Check readiness status
+
+This endpoint returns a 200 status code when the HTTP server 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 this service, the health status will never refer to the cluster state, only to a single instance.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::HealthApi.new
+
+begin
+  #Check readiness status
+  result = api_instance.is_instance_ready
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling HealthApi->is_instance_ready: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthStatus**](HealthStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/HealthNotReadyStatus.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::HealthNotReadyStatus
+
+## 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::HealthNotReadyStatus.new(
+  errors: null
+)
+```
+

data/docs/HealthStatus.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::HealthStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Status always contains \"ok\". | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::HealthStatus.new(
+  status: null
+)
+```
+

data/docs/InlineResponse500.md

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

data/docs/IsInstanceAliveInternalServerError.md

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

data/docs/IsInstanceAliveInternalServerErrorBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::IsInstanceAliveInternalServerErrorBody
+
+## 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::IsInstanceAliveInternalServerErrorBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/IsInstanceAliveOK.md

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

data/docs/JsonWebKey.md

@@ -0,0 +1,50 @@
+# OryOathkeeperClient::JsonWebKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alg** | **String** | The \"alg\" (algorithm) parameter identifies the algorithm intended for use with the key.  The values used should either be registered in the IANA \"JSON Web Signature and Encryption Algorithms\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. | [optional] |
+| **crv** | **String** |  | [optional] |
+| **d** | **String** |  | [optional] |
+| **dp** | **String** |  | [optional] |
+| **dq** | **String** |  | [optional] |
+| **e** | **String** |  | [optional] |
+| **k** | **String** |  | [optional] |
+| **kid** | **String** | The \"kid\" (key ID) parameter is used to match a specific key.  This is used, for instance, to choose among a set of keys within a JWK Set during key rollover.  The structure of the \"kid\" value is unspecified.  When \"kid\" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct \"kid\" values.  (One example in which different keys might use the same \"kid\" value is if they have different \"kty\" (key type) values but are considered to be equivalent alternatives by the application using them.)  The \"kid\" value is a case-sensitive string. | [optional] |
+| **kty** | **String** | The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\". \"kty\" values should either be registered in the IANA \"JSON Web Key Types\" registry established by [JWA] or be a value that contains a Collision- Resistant Name.  The \"kty\" value is a case-sensitive string. | [optional] |
+| **n** | **String** |  | [optional] |
+| **p** | **String** |  | [optional] |
+| **q** | **String** |  | [optional] |
+| **qi** | **String** |  | [optional] |
+| **use** | **String** | The \"use\" (public key use) parameter identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption). | [optional] |
+| **x** | **String** |  | [optional] |
+| **x5c** | **Array<String>** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280].  The certificate chain is represented as a JSON array of certificate value strings.  Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional] |
+| **y** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-oathkeeper-client'
+
+instance = OryOathkeeperClient::JsonWebKey.new(
+  alg: null,
+  crv: null,
+  d: null,
+  dp: null,
+  dq: null,
+  e: null,
+  k: null,
+  kid: null,
+  kty: null,
+  n: null,
+  p: null,
+  q: null,
+  qi: null,
+  use: null,
+  x: null,
+  x5c: null,
+  y: null
+)
+```
+

data/docs/JsonWebKeySet.md

@@ -0,0 +1,18 @@
+# OryOathkeeperClient::JsonWebKeySet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | [**Array<JsonWebKey>**](JsonWebKey.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::JsonWebKeySet.new(
+  keys: null
+)
+```
+

data/docs/JudgeForbidden.md

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

data/docs/JudgeForbiddenBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::JudgeForbiddenBody
+
+## 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::JudgeForbiddenBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/JudgeInternalServerError.md

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

data/docs/JudgeInternalServerErrorBody.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::JudgeInternalServerErrorBody
+
+## 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::JudgeInternalServerErrorBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+