ory-hydra-client 1.11.7 → 2.0.1

data/docs/TokenPaginationRequestParameters.md

@@ -0,0 +1,20 @@
+# OryHydraClient::TokenPaginationRequestParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** | Items per Page  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to '1'] |
+
+## Example
+
+```ruby
+require 'ory-hydra-client'
+
+instance = OryHydraClient::TokenPaginationRequestParameters.new(
+  page_size: null,
+  page_token: null
+)
+```
+

data/docs/TokenPaginationResponseHeaders.md

@@ -0,0 +1,20 @@
+# OryHydraClient::TokenPaginationResponseHeaders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link** | **String** | The Link HTTP Header  The `Link` header contains a comma-delimited list of links to the following pages:  first: The first page of results. next: The next page of results. prev: The previous page of results. last: The last page of results.  Pages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples:  </clients?limit=5&offset=0>; rel=\"first\",</clients?limit=5&offset=15>; rel=\"next\",</clients?limit=5&offset=5>; rel=\"prev\",</clients?limit=5&offset=20>; rel=\"last\" | [optional] |
+| **x_total_count** | **Integer** | The X-Total-Count HTTP Header  The `X-Total-Count` header contains the total number of items in the collection. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-hydra-client'
+
+instance = OryHydraClient::TokenPaginationResponseHeaders.new(
+  link: null,
+  x_total_count: null
+)
+```
+

data/docs/{TrustJwtGrantIssuerBody.md → TrustOAuth2JwtGrantIssuer.md}

@@ -1,21 +1,23 @@
-# OryHydraClient::TrustJwtGrantIssuerBody
+# OryHydraClient::TrustOAuth2JwtGrantIssuer
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **allow_any_subject** | **Boolean** | The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT. | [optional] |
 | **expires_at** | **Time** | The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\". |  |
 | **issuer** | **String** | The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT). |  |
-| **jwk** | [**JSONWebKey**](JSONWebKey.md) |  |  |
+| **jwk** | [**JsonWebKey**](JsonWebKey.md) |  |  |
 | **scope** | **Array<String>** | The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) |  |
-| **subject** | **String** | The \"subject\" identifies the principal that is the subject of the JWT. |  |
+| **subject** | **String** | The \"subject\" identifies the principal that is the subject of the JWT. | [optional] |
 
 ## Example
 
 ```ruby
 require 'ory-hydra-client'
 
-instance = OryHydraClient::TrustJwtGrantIssuerBody.new(
+instance = OryHydraClient::TrustOAuth2JwtGrantIssuer.new(
+  allow_any_subject: null,
   expires_at: null,
   issuer: https://jwt-idp.example.com,
   jwk: null,

data/docs/{TrustedJwtGrantIssuer.md → TrustedOAuth2JwtGrantIssuer.md}

@@ -1,14 +1,15 @@
-# OryHydraClient::TrustedJwtGrantIssuer
+# OryHydraClient::TrustedOAuth2JwtGrantIssuer
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **allow_any_subject** | **Boolean** | The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT. | [optional] |
 | **created_at** | **Time** | The \"created_at\" indicates, when grant was created. | [optional] |
 | **expires_at** | **Time** | The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\". | [optional] |
 | **id** | **String** |  | [optional] |
 | **issuer** | **String** | The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT). | [optional] |
-| **public_key** | [**TrustedJsonWebKey**](TrustedJsonWebKey.md) |  | [optional] |
+| **public_key** | [**TrustedOAuth2JwtGrantJsonWebKey**](TrustedOAuth2JwtGrantJsonWebKey.md) |  | [optional] |
 | **scope** | **Array<String>** | The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) | [optional] |
 | **subject** | **String** | The \"subject\" identifies the principal that is the subject of the JWT. | [optional] |
 
@@ -17,7 +18,8 @@
 ```ruby
 require 'ory-hydra-client'
 
-instance = OryHydraClient::TrustedJwtGrantIssuer.new(
+instance = OryHydraClient::TrustedOAuth2JwtGrantIssuer.new(
+  allow_any_subject: null,
   created_at: null,
   expires_at: null,
   id: 9edc811f-4e28-453c-9b46-4de65f00217f,

data/docs/{TrustedJsonWebKey.md → TrustedOAuth2JwtGrantJsonWebKey.md}

@@ -1,4 +1,4 @@
-# OryHydraClient::TrustedJsonWebKey
+# OryHydraClient::TrustedOAuth2JwtGrantJsonWebKey
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-hydra-client'
 
-instance = OryHydraClient::TrustedJsonWebKey.new(
+instance = OryHydraClient::TrustedOAuth2JwtGrantJsonWebKey.new(
   kid: 123e4567-e89b-12d3-a456-426655440000,
   set: https://jwt-idp.example.com
 )

data/docs/WellknownApi.md

@@ -0,0 +1,69 @@
+# OryHydraClient::WellknownApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**discover_json_web_keys**](WellknownApi.md#discover_json_web_keys) | **GET** /.well-known/jwks.json | Discover Well-Known JSON Web Keys |
+
+
+## discover_json_web_keys
+
+> <JsonWebKeySet> discover_json_web_keys
+
+Discover Well-Known JSON Web Keys
+
+This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-hydra-client'
+
+api_instance = OryHydraClient::WellknownApi.new
+
+begin
+  # Discover Well-Known JSON Web Keys
+  result = api_instance.discover_json_web_keys
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WellknownApi->discover_json_web_keys: #{e}"
+end
+```
+
+#### Using the discover_json_web_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> discover_json_web_keys_with_http_info
+
+```ruby
+begin
+  # Discover Well-Known JSON Web Keys
+  data, status_code, headers = api_instance.discover_json_web_keys_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WellknownApi->discover_json_web_keys_with_http_info: #{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
+