ory-hydra-client 1.7.0 → 1.7.3

data/docs/PublicApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel enabled Logout
+[**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
 [**discover_open_id_configuration**](PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
-[**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
-[**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 token endpoint
-[**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 authorize endpoint
-[**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 tokens
+[**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
+[**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint
+[**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint
+[**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 Tokens
 [**userinfo**](PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
 [**well_known**](PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
 
@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 > disconnect_user
 
-OpenID Connect Front-Backchannel enabled Logout
+OpenID Connect Front-Backchannel Enabled Logout
 
 This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:  https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html
 
@@ -32,7 +32,7 @@ require 'ory-hydra-client'
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #OpenID Connect Front-Backchannel enabled Logout
+  #OpenID Connect Front-Backchannel Enabled Logout
   api_instance.disconnect_user
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->disconnect_user: #{e}"
@@ -104,7 +104,7 @@ No authorization required
 
 > HealthStatus is_instance_ready
 
-Check readiness status
+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.
 
@@ -117,7 +117,7 @@ require 'ory-hydra-client'
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #Check readiness status
+  #Check Readiness Status
   result = api_instance.is_instance_ready
   p result
 rescue OryHydraClient::ApiError => e
@@ -147,7 +147,7 @@ No authorization required
 
 > Oauth2TokenResponse oauth2_token(grant_type, opts)
 
-The OAuth 2.0 token endpoint
+The OAuth 2.0 Token Endpoint
 
 The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body.  > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
 
@@ -176,7 +176,7 @@ opts = {
 }
 
 begin
-  #The OAuth 2.0 token endpoint
+  #The OAuth 2.0 Token Endpoint
   result = api_instance.oauth2_token(grant_type, opts)
   p result
 rescue OryHydraClient::ApiError => e
@@ -213,7 +213,7 @@ Name | Type | Description  | Notes
 
 > oauth_auth
 
-The OAuth 2.0 authorize endpoint
+The OAuth 2.0 Authorize Endpoint
 
 This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists.  To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
 
@@ -226,7 +226,7 @@ require 'ory-hydra-client'
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #The OAuth 2.0 authorize endpoint
+  #The OAuth 2.0 Authorize Endpoint
   api_instance.oauth_auth
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->oauth_auth: #{e}"
@@ -255,7 +255,7 @@ No authorization required
 
 > revoke_o_auth2_token(token)
 
-Revoke OAuth2 tokens
+Revoke OAuth2 Tokens
 
 Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
 
@@ -278,7 +278,7 @@ api_instance = OryHydraClient::PublicApi.new
 token = 'token_example' # String | 
 
 begin
-  #Revoke OAuth2 tokens
+  #Revoke OAuth2 Tokens
   api_instance.revoke_o_auth2_token(token)
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->revoke_o_auth2_token: #{e}"

data/lib/ory-hydra-client.rb

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

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

@@ -3,7 +3,7 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.7.0
+The version of the OpenAPI document: v1.7.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -19,7 +19,7 @@ module OryHydraClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Accept a consent request
+    # Accept a Consent Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\").  The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.  This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -30,7 +30,7 @@ module OryHydraClient
       data
     end
 
-    # Accept a consent request
+    # Accept a Consent Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\").  The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.  This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -86,7 +86,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Accept a login request
+    # Accept a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\").  The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.  This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie.  The response contains a redirect URL which the login provider should redirect the user-agent to.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -97,7 +97,7 @@ module OryHydraClient
       data
     end
 
-    # Accept a login request
+    # Accept a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\").  The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.  This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie.  The response contains a redirect URL which the login provider should redirect the user-agent to.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -153,7 +153,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Accept a logout request
+    # Accept a Logout Request
     # When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -163,7 +163,7 @@ module OryHydraClient
       data
     end
 
-    # Accept a logout request
+    # Accept a Logout Request
     # When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -216,7 +216,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Generate a new JSON Web Key
+    # Generate a New JSON Web Key
     # This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created.  A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
     # @param set [String] The set
     # @param [Hash] opts the optional parameters
@@ -227,7 +227,7 @@ module OryHydraClient
       data
     end
 
-    # Generate a new JSON Web Key
+    # Generate a New JSON Web Key
     # This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created.  A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
     # @param set [String] The set
     # @param [Hash] opts the optional parameters
@@ -282,7 +282,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Create an OAuth 2.0 client
+    # Create an OAuth 2.0 Client
     # Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
     # @param body [OAuth2Client] 
     # @param [Hash] opts the optional parameters
@@ -292,7 +292,7 @@ module OryHydraClient
       data
     end
 
-    # Create an OAuth 2.0 client
+    # Create an OAuth 2.0 Client
     # Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
     # @param body [OAuth2Client] 
     # @param [Hash] opts the optional parameters
@@ -598,7 +598,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Get consent request information
+    # Get Consent Request Information
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\").  The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -608,7 +608,7 @@ module OryHydraClient
       data
     end
 
-    # Get consent request information
+    # Get Consent Request Information
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\").  The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -791,7 +791,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Get a login request
+    # Get a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\").  The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -801,7 +801,7 @@ module OryHydraClient
       data
     end
 
-    # Get a login request
+    # Get a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\").  The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -854,7 +854,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Get a logout request
+    # Get a Logout Request
     # Use this endpoint to fetch a logout request.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -864,7 +864,7 @@ module OryHydraClient
       data
     end
 
-    # Get a logout request
+    # Get a Logout Request
     # Use this endpoint to fetch a logout request.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -979,7 +979,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Get service version
+    # Get Service Version
     # This endpoint returns the service version typically notated using semantic versioning.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
     # @param [Hash] opts the optional parameters
     # @return [Version]
@@ -988,7 +988,7 @@ module OryHydraClient
       data
     end
 
-    # Get service version
+    # Get Service Version
     # This endpoint returns the service version typically notated using semantic versioning.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Version, Integer, Hash)>] Version data, response status code and response headers
@@ -1035,7 +1035,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Introspect OAuth2 tokens
+    # Introspect OAuth2 Tokens
     # The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow.  For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
     # @param token [String] The string value of the token. For access tokens, this is the \\\&quot;access_token\\\&quot; value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\&quot;refresh_token\\\&quot; value returned.
     # @param [Hash] opts the optional parameters
@@ -1046,7 +1046,7 @@ module OryHydraClient
       data
     end
 
-    # Introspect OAuth2 tokens
+    # Introspect OAuth2 Tokens
     # The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting &#x60;accessTokenExtra&#x60; during the consent flow.  For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
     # @param token [String] The string value of the token. For access tokens, this is the \\\&quot;access_token\\\&quot; value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\&quot;refresh_token\\\&quot; value returned.
     # @param [Hash] opts the optional parameters
@@ -1085,7 +1085,7 @@ module OryHydraClient
       return_type = opts[:return_type] || 'OAuth2TokenIntrospection' 
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basic', 'oauth2']
+      auth_names = opts[:auth_names] || []
 
       new_options = opts.merge(
         :header_params => header_params,
@@ -1103,7 +1103,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Check alive status
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [HealthStatus]
@@ -1112,7 +1112,7 @@ module OryHydraClient
       data
     end
 
-    # Check alive status
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
     # @param [Hash] opts the optional parameters
     # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
@@ -1221,7 +1221,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Lists all consent sessions of a subject
+    # Lists All Consent Sessions of a Subject
     # This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK.   The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
     # @param subject [String] 
     # @param [Hash] opts the optional parameters
@@ -1231,7 +1231,7 @@ module OryHydraClient
       data
     end
 
-    # Lists all consent sessions of a subject
+    # Lists All Consent Sessions of a Subject
     # This endpoint lists all subject&#39;s granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK.   The \&quot;Link\&quot; header is also included in successful responses, which contains one or more links for pagination, formatted like so: &#39;&lt;https://hydra-url/admin/oauth2/auth/sessions/consent?subject&#x3D;{user}&amp;limit&#x3D;{limit}&amp;offset&#x3D;{offset}&gt;; rel&#x3D;\&quot;{page}\&quot;&#39;, where page is one of the following applicable pages: &#39;first&#39;, &#39;next&#39;, &#39;last&#39;, and &#39;previous&#39;. Multiple links can be included in this header, and will be separated by a comma.
     # @param subject [String] 
     # @param [Hash] opts the optional parameters
@@ -1338,7 +1338,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Reject a consent request
+    # Reject a Consent Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\").  The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.  This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1349,7 +1349,7 @@ module OryHydraClient
       data
     end
 
-    # Reject a consent request
+    # Reject a Consent Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject&#39;s behalf.  The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\&quot;Application my-dropbox-app wants write access to all your private files\&quot;).  The consent challenge is appended to the consent provider&#39;s URL to which the subject&#39;s user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.  This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted.  The response contains a redirect URL which the consent provider should redirect the user-agent to.
     # @param consent_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1405,7 +1405,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Reject a login request
+    # Reject a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\").  The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.  This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied.  The response contains a redirect URL which the login provider should redirect the user-agent to.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1416,7 +1416,7 @@ module OryHydraClient
       data
     end
 
-    # Reject a login request
+    # Reject a Login Request
     # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \&quot;identity provider\&quot;) to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\&quot;show the subject a login screen\&quot;) a subject (in OAuth2 the proper name for subject is \&quot;resource owner\&quot;).  The authentication challenge is appended to the login provider URL to which the subject&#39;s user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.  This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied.  The response contains a redirect URL which the login provider should redirect the user-agent to.
     # @param login_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1472,7 +1472,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Reject a logout request
+    # Reject a Logout Request
     # When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required.  The response is empty as the logout provider has to chose what action to perform next.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1483,7 +1483,7 @@ module OryHydraClient
       nil
     end
 
-    # Reject a logout request
+    # Reject a Logout Request
     # When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required.  The response is empty as the logout provider has to chose what action to perform next.
     # @param logout_challenge [String] 
     # @param [Hash] opts the optional parameters
@@ -1539,7 +1539,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Invalidates all login sessions of a certain user Invalidates a subject's authentication session
+    # Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
     # This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
     # @param subject [String] 
     # @param [Hash] opts the optional parameters
@@ -1549,7 +1549,7 @@ module OryHydraClient
       nil
     end
 
-    # Invalidates all login sessions of a certain user Invalidates a subject&#39;s authentication session
+    # Invalidates All Login Sessions of a Certain User Invalidates a Subject&#39;s Authentication Session
     # This endpoint invalidates a subject&#39;s authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
     # @param subject [String] 
     # @param [Hash] opts the optional parameters
@@ -1602,7 +1602,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Revokes consent sessions of a subject for a specific OAuth 2.0 Client
+    # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
     # This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
     # @param subject [String] The subject (Subject) who&#39;s consent sessions should be deleted.
     # @param [Hash] opts the optional parameters
@@ -1614,7 +1614,7 @@ module OryHydraClient
       nil
     end
 
-    # Revokes consent sessions of a subject for a specific OAuth 2.0 Client
+    # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
     # This endpoint revokes a subject&#39;s granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
     # @param subject [String] The subject (Subject) who&#39;s consent sessions should be deleted.
     # @param [Hash] opts the optional parameters

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

@@ -3,7 +3,7 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.7.0
+The version of the OpenAPI document: v1.7.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -19,7 +19,7 @@ module OryHydraClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # OpenID Connect Front-Backchannel enabled Logout
+    # OpenID Connect Front-Backchannel Enabled Logout
     # This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:  https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -28,7 +28,7 @@ module OryHydraClient
       nil
     end
 
-    # OpenID Connect Front-Backchannel enabled Logout
+    # OpenID Connect Front-Backchannel Enabled Logout
     # This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:  https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -129,7 +129,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Check readiness status
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [HealthStatus]
@@ -138,7 +138,7 @@ module OryHydraClient
       data
     end
 
-    # Check readiness status
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
     # @param [Hash] opts the optional parameters
     # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
@@ -185,7 +185,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # The OAuth 2.0 token endpoint
+    # The OAuth 2.0 Token Endpoint
     # The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body.  > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
     # @param grant_type [String] 
     # @param [Hash] opts the optional parameters
@@ -199,7 +199,7 @@ module OryHydraClient
       data
     end
 
-    # The OAuth 2.0 token endpoint
+    # The OAuth 2.0 Token Endpoint
     # The client makes a request to the token endpoint by sending the following parameters using the \&quot;application/x-www-form-urlencoded\&quot; HTTP request entity-body.  &gt; Do not implement a client for this endpoint yourself. Use a library. There are many libraries &gt; available for any programming language. You can find a list of libraries here: https://oauth.net/code/ &gt; &gt; Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
     # @param grant_type [String] 
     # @param [Hash] opts the optional parameters
@@ -262,7 +262,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # The OAuth 2.0 authorize endpoint
+    # The OAuth 2.0 Authorize Endpoint
     # This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists.  To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -271,7 +271,7 @@ module OryHydraClient
       nil
     end
 
-    # The OAuth 2.0 authorize endpoint
+    # The OAuth 2.0 Authorize Endpoint
     # This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists.  To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -318,7 +318,7 @@ module OryHydraClient
       return data, status_code, headers
     end
 
-    # Revoke OAuth2 tokens
+    # Revoke OAuth2 Tokens
     # Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
     # @param token [String] 
     # @param [Hash] opts the optional parameters
@@ -328,7 +328,7 @@ module OryHydraClient
       nil
     end
 
-    # Revoke OAuth2 tokens
+    # Revoke OAuth2 Tokens
     # Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
     # @param token [String] 
     # @param [Hash] opts the optional parameters