ory-hydra-client 1.9.0 → 1.9.1

data/docs/RejectRequest.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | **String** | The error should follow the OAuth2 error format (e.g. `invalid_request`, `login_required`).  Defaults to `request_denied`. | [optional] 
-**error_debug** | **String** | Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs. | [optional] 
-**error_description** | **String** | Description of the error in a human readable format. | [optional] 
-**error_hint** | **String** | Hint to help resolve the error. | [optional] 
-**status_code** | **Integer** | Represents the HTTP status code of the error (e.g. 401 or 403)  Defaults to 400 | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | The error should follow the OAuth2 error format (e.g. `invalid_request`, `login_required`).  Defaults to `request_denied`. | [optional] |
+| **error_debug** | **String** | Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs. | [optional] |
+| **error_description** | **String** | Description of the error in a human readable format. | [optional] |
+| **error_hint** | **String** | Hint to help resolve the error. | [optional] |
+| **status_code** | **Integer** | Represents the HTTP status code of the error (e.g. 401 or 403)  Defaults to 400 | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::RejectRequest.new(error: null,
-                                 error_debug: null,
-                                 error_description: null,
-                                 error_hint: null,
-                                 status_code: null)
+instance = OryHydraClient::RejectRequest.new(
+  error: null,
+  error_debug: null,
+  error_description: null,
+  error_hint: null,
+  status_code: null
+)
 ```
 
-

data/docs/UserinfoResponse.md

@@ -2,52 +2,53 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**birthdate** | **String** | End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates. | [optional] 
-**email** | **String** | End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. | [optional] 
-**email_verified** | **Boolean** | True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. | [optional] 
-**family_name** | **String** | Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. | [optional] 
-**gender** | **String** | End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. | [optional] 
-**given_name** | **String** | Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. | [optional] 
-**locale** | **String** | End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. | [optional] 
-**middle_name** | **String** | Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. | [optional] 
-**name** | **String** | End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. | [optional] 
-**nickname** | **String** | Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael. | [optional] 
-**phone_number** | **String** | End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. | [optional] 
-**phone_number_verified** | **Boolean** | True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format. | [optional] 
-**picture** | **String** | URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. | [optional] 
-**preferred_username** | **String** | Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. | [optional] 
-**profile** | **String** | URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. | [optional] 
-**sub** | **String** | Subject - Identifier for the End-User at the IssuerURL. | [optional] 
-**updated_at** | **Integer** | Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. | [optional] 
-**website** | **String** | URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. | [optional] 
-**zoneinfo** | **String** | String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **birthdate** | **String** | End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates. | [optional] |
+| **email** | **String** | End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. | [optional] |
+| **email_verified** | **Boolean** | True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. | [optional] |
+| **family_name** | **String** | Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. | [optional] |
+| **gender** | **String** | End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. | [optional] |
+| **given_name** | **String** | Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. | [optional] |
+| **locale** | **String** | End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. | [optional] |
+| **middle_name** | **String** | Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. | [optional] |
+| **name** | **String** | End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. | [optional] |
+| **nickname** | **String** | Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael. | [optional] |
+| **phone_number** | **String** | End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. | [optional] |
+| **phone_number_verified** | **Boolean** | True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format. | [optional] |
+| **picture** | **String** | URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. | [optional] |
+| **preferred_username** | **String** | Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. | [optional] |
+| **profile** | **String** | URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. | [optional] |
+| **sub** | **String** | Subject - Identifier for the End-User at the IssuerURL. | [optional] |
+| **updated_at** | **Integer** | Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. | [optional] |
+| **website** | **String** | URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. | [optional] |
+| **zoneinfo** | **String** | String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::UserinfoResponse.new(birthdate: null,
-                                 email: null,
-                                 email_verified: null,
-                                 family_name: null,
-                                 gender: null,
-                                 given_name: null,
-                                 locale: null,
-                                 middle_name: null,
-                                 name: null,
-                                 nickname: null,
-                                 phone_number: null,
-                                 phone_number_verified: null,
-                                 picture: null,
-                                 preferred_username: null,
-                                 profile: null,
-                                 sub: null,
-                                 updated_at: null,
-                                 website: null,
-                                 zoneinfo: null)
+instance = OryHydraClient::UserinfoResponse.new(
+  birthdate: null,
+  email: null,
+  email_verified: null,
+  family_name: null,
+  gender: null,
+  given_name: null,
+  locale: null,
+  middle_name: null,
+  name: null,
+  nickname: null,
+  phone_number: null,
+  phone_number_verified: null,
+  picture: null,
+  preferred_username: null,
+  profile: null,
+  sub: null,
+  updated_at: null,
+  website: null,
+  zoneinfo: null
+)
 ```
 
-

data/docs/Version.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** | Version is the service's version. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::Version.new(version: null)
+instance = OryHydraClient::Version.new(
+  version: null
+)
 ```
 
-

data/docs/VolumeUsageData.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ref_count** | **Integer** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | 
-**size** | **Integer** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ref_count** | **Integer** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. |  |
+| **size** | **Integer** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::VolumeUsageData.new(ref_count: null,
-                                 size: null)
+instance = OryHydraClient::VolumeUsageData.new(
+  ref_count: null,
+  size: null
+)
 ```
 
-

data/docs/WellKnown.md

@@ -2,66 +2,67 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authorization_endpoint** | **String** | URL of the OP's OAuth 2.0 Authorization Endpoint. | 
-**backchannel_logout_session_supported** | **Boolean** | Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP | [optional] 
-**backchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports back-channel logout, with true indicating support. | [optional] 
-**claims_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. | [optional] 
-**claims_supported** | **Array<String>** | JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. | [optional] 
-**end_session_endpoint** | **String** | URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. | [optional] 
-**frontchannel_logout_session_supported** | **Boolean** | Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. | [optional] 
-**frontchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. | [optional] 
-**grant_types_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. | [optional] 
-**id_token_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. | 
-**issuer** | **String** | URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL. | 
-**jwks_uri** | **String** | URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. | 
-**registration_endpoint** | **String** | URL of the OP's Dynamic Client Registration Endpoint. | [optional] 
-**request_object_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). | [optional] 
-**request_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. | [optional] 
-**request_uri_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. | [optional] 
-**require_request_uri_registration** | **Boolean** | Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. | [optional] 
-**response_modes_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports. | [optional] 
-**response_types_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. | 
-**revocation_endpoint** | **String** | URL of the authorization server's OAuth 2.0 revocation endpoint. | [optional] 
-**scopes_supported** | **Array<String>** | SON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used | [optional] 
-**subject_types_supported** | **Array<String>** | JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. | 
-**token_endpoint** | **String** | URL of the OP's OAuth 2.0 Token Endpoint | 
-**token_endpoint_auth_methods_supported** | **Array<String>** | JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 | [optional] 
-**userinfo_endpoint** | **String** | URL of the OP's UserInfo Endpoint. | [optional] 
-**userinfo_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_endpoint** | **String** | URL of the OP's OAuth 2.0 Authorization Endpoint. |  |
+| **backchannel_logout_session_supported** | **Boolean** | Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP | [optional] |
+| **backchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports back-channel logout, with true indicating support. | [optional] |
+| **claims_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. | [optional] |
+| **claims_supported** | **Array<String>** | JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. | [optional] |
+| **end_session_endpoint** | **String** | URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. | [optional] |
+| **frontchannel_logout_session_supported** | **Boolean** | Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. | [optional] |
+| **frontchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. | [optional] |
+| **grant_types_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. | [optional] |
+| **id_token_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. |  |
+| **issuer** | **String** | URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL. |  |
+| **jwks_uri** | **String** | URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. |  |
+| **registration_endpoint** | **String** | URL of the OP's Dynamic Client Registration Endpoint. | [optional] |
+| **request_object_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). | [optional] |
+| **request_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. | [optional] |
+| **request_uri_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. | [optional] |
+| **require_request_uri_registration** | **Boolean** | Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. | [optional] |
+| **response_modes_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports. | [optional] |
+| **response_types_supported** | **Array<String>** | JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. |  |
+| **revocation_endpoint** | **String** | URL of the authorization server's OAuth 2.0 revocation endpoint. | [optional] |
+| **scopes_supported** | **Array<String>** | SON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used | [optional] |
+| **subject_types_supported** | **Array<String>** | JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. |  |
+| **token_endpoint** | **String** | URL of the OP's OAuth 2.0 Token Endpoint |  |
+| **token_endpoint_auth_methods_supported** | **Array<String>** | JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 | [optional] |
+| **userinfo_endpoint** | **String** | URL of the OP's UserInfo Endpoint. | [optional] |
+| **userinfo_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::WellKnown.new(authorization_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/auth,
-                                 backchannel_logout_session_supported: null,
-                                 backchannel_logout_supported: null,
-                                 claims_parameter_supported: null,
-                                 claims_supported: null,
-                                 end_session_endpoint: null,
-                                 frontchannel_logout_session_supported: null,
-                                 frontchannel_logout_supported: null,
-                                 grant_types_supported: null,
-                                 id_token_signing_alg_values_supported: null,
-                                 issuer: https://playground.ory.sh/ory-hydra/public/,
-                                 jwks_uri: https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json,
-                                 registration_endpoint: https://playground.ory.sh/ory-hydra/admin/client,
-                                 request_object_signing_alg_values_supported: null,
-                                 request_parameter_supported: null,
-                                 request_uri_parameter_supported: null,
-                                 require_request_uri_registration: null,
-                                 response_modes_supported: null,
-                                 response_types_supported: null,
-                                 revocation_endpoint: null,
-                                 scopes_supported: null,
-                                 subject_types_supported: null,
-                                 token_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/token,
-                                 token_endpoint_auth_methods_supported: null,
-                                 userinfo_endpoint: null,
-                                 userinfo_signing_alg_values_supported: null)
+instance = OryHydraClient::WellKnown.new(
+  authorization_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/auth,
+  backchannel_logout_session_supported: null,
+  backchannel_logout_supported: null,
+  claims_parameter_supported: null,
+  claims_supported: null,
+  end_session_endpoint: null,
+  frontchannel_logout_session_supported: null,
+  frontchannel_logout_supported: null,
+  grant_types_supported: null,
+  id_token_signing_alg_values_supported: null,
+  issuer: https://playground.ory.sh/ory-hydra/public/,
+  jwks_uri: https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json,
+  registration_endpoint: https://playground.ory.sh/ory-hydra/admin/client,
+  request_object_signing_alg_values_supported: null,
+  request_parameter_supported: null,
+  request_uri_parameter_supported: null,
+  require_request_uri_registration: null,
+  response_modes_supported: null,
+  response_types_supported: null,
+  revocation_endpoint: null,
+  scopes_supported: null,
+  subject_types_supported: null,
+  token_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/token,
+  token_endpoint_auth_methods_supported: null,
+  userinfo_endpoint: null,
+  userinfo_signing_alg_values_supported: null
+)
 ```
 
-

data/lib/ory-hydra-client.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.0
+The version of the OpenAPI document: v1.9.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 5.0.0
 
 =end
 

data/lib/ory-hydra-client/api/admin_api.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.0
+The version of the OpenAPI document: v1.9.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
@@ -62,15 +62,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'CompletedRequest' 
+      return_type = opts[:debug_return_type] || 'CompletedRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.accept_consent_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -129,15 +130,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'CompletedRequest' 
+      return_type = opts[:debug_return_type] || 'CompletedRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.accept_login_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -192,15 +194,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'CompletedRequest' 
+      return_type = opts[:debug_return_type] || 'CompletedRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.accept_logout_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -258,15 +261,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'JSONWebKeySet' 
+      return_type = opts[:debug_return_type] || 'JSONWebKeySet'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.create_json_web_key_set",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -322,15 +326,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
 
       # return_type
-      return_type = opts[:return_type] || 'OAuth2Client' 
+      return_type = opts[:debug_return_type] || 'OAuth2Client'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.create_o_auth2_client",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -390,15 +395,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.delete_json_web_key",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -452,15 +458,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.delete_json_web_key_set",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -514,15 +521,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.delete_o_auth2_client",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -577,15 +585,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.delete_o_auth2_token",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -637,15 +646,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.flush_inactive_o_auth2_tokens",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -700,15 +710,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'ConsentRequest' 
+      return_type = opts[:debug_return_type] || 'ConsentRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_consent_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -768,15 +779,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'JSONWebKeySet' 
+      return_type = opts[:debug_return_type] || 'JSONWebKeySet'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_json_web_key",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -830,15 +842,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'JSONWebKeySet' 
+      return_type = opts[:debug_return_type] || 'JSONWebKeySet'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_json_web_key_set",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -893,15 +906,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'LoginRequest' 
+      return_type = opts[:debug_return_type] || 'LoginRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_login_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -956,15 +970,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'LogoutRequest' 
+      return_type = opts[:debug_return_type] || 'LogoutRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_logout_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1018,15 +1033,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'OAuth2Client' 
+      return_type = opts[:debug_return_type] || 'OAuth2Client'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_o_auth2_client",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1074,15 +1090,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Version' 
+      return_type = opts[:debug_return_type] || 'Version'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.get_version",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1142,15 +1159,16 @@ module OryHydraClient
       form_params['scope'] = opts[:'scope'] if !opts[:'scope'].nil?
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'OAuth2TokenIntrospection' 
+      return_type = opts[:debug_return_type] || 'OAuth2TokenIntrospection'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.introspect_o_auth2_token",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1198,15 +1216,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'HealthStatus' 
+      return_type = opts[:debug_return_type] || 'HealthStatus'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.is_instance_alive",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1260,15 +1279,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Array<OAuth2Client>' 
+      return_type = opts[:debug_return_type] || 'Array<OAuth2Client>'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.list_o_auth2_clients",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1323,15 +1343,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Array<PreviousConsentSession>' 
+      return_type = opts[:debug_return_type] || 'Array<PreviousConsentSession>'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.list_subject_consent_sessions",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1377,15 +1398,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.prometheus",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1444,15 +1466,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'CompletedRequest' 
+      return_type = opts[:debug_return_type] || 'CompletedRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.reject_consent_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1511,15 +1534,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'CompletedRequest' 
+      return_type = opts[:debug_return_type] || 'CompletedRequest'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.reject_login_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1578,15 +1602,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.reject_logout_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1641,15 +1666,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.revoke_authentication_session",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1710,15 +1736,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.revoke_consent_sessions",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1782,15 +1809,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'JSONWebKey' 
+      return_type = opts[:debug_return_type] || 'JSONWebKey'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.update_json_web_key",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1848,15 +1876,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
 
       # return_type
-      return_type = opts[:return_type] || 'JSONWebKeySet' 
+      return_type = opts[:debug_return_type] || 'JSONWebKeySet'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.update_json_web_key_set",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -1918,15 +1947,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
 
       # return_type
-      return_type = opts[:return_type] || 'OAuth2Client' 
+      return_type = opts[:debug_return_type] || 'OAuth2Client'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"AdminApi.update_o_auth2_client",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,