# ory-hydra-client OryHydraClient - the Ruby gem for the Ory Hydra API Documentation for all of Ory Hydra's APIs. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v2.2.1 - Package version: v2.2.1 - Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation ### Build a gem To build the Ruby code into a gem: ```shell gem build ory-hydra-client.gemspec ``` Then either install the gem locally: ```shell gem install ./ory-hydra-client-v2.2.1.gem ``` (for development, run `gem install --dev ./ory-hydra-client-v2.2.1.gem` to install the development dependencies) or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). Finally add this to the Gemfile: gem 'ory-hydra-client', '~> v2.2.1' ### Install from Git If the Ruby gem is hosted at a git repository: https://github.com/ory/sdk, then add the following in the Gemfile: gem 'ory-hydra-client', :git => 'https://github.com/ory/sdk.git' ### Include the Ruby code directly Include the Ruby code directly using `-I` as follows: ```shell ruby -Ilib script.rb ``` ## Getting Started Please follow the [installation](#installation) procedure and then run the following code: ```ruby # Load the gem require 'ory-hydra-client' api_instance = OryHydraClient::JwkApi.new set = 'set_example' # String | The JSON Web Key Set ID create_json_web_key_set = OryHydraClient::CreateJsonWebKeySet.new({alg: 'alg_example', kid: 'kid_example', use: 'use_example'}) # CreateJsonWebKeySet | begin #Create JSON Web Key result = api_instance.create_json_web_key_set(set, create_json_web_key_set) p result rescue OryHydraClient::ApiError => e puts "Exception when calling JwkApi->create_json_web_key_set: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OryHydraClient::JwkApi* | [**create_json_web_key_set**](docs/JwkApi.md#create_json_web_key_set) | **POST** /admin/keys/{set} | Create JSON Web Key *OryHydraClient::JwkApi* | [**delete_json_web_key**](docs/JwkApi.md#delete_json_web_key) | **DELETE** /admin/keys/{set}/{kid} | Delete JSON Web Key *OryHydraClient::JwkApi* | [**delete_json_web_key_set**](docs/JwkApi.md#delete_json_web_key_set) | **DELETE** /admin/keys/{set} | Delete JSON Web Key Set *OryHydraClient::JwkApi* | [**get_json_web_key**](docs/JwkApi.md#get_json_web_key) | **GET** /admin/keys/{set}/{kid} | Get JSON Web Key *OryHydraClient::JwkApi* | [**get_json_web_key_set**](docs/JwkApi.md#get_json_web_key_set) | **GET** /admin/keys/{set} | Retrieve a JSON Web Key Set *OryHydraClient::JwkApi* | [**set_json_web_key**](docs/JwkApi.md#set_json_web_key) | **PUT** /admin/keys/{set}/{kid} | Set JSON Web Key *OryHydraClient::JwkApi* | [**set_json_web_key_set**](docs/JwkApi.md#set_json_web_key_set) | **PUT** /admin/keys/{set} | Update a JSON Web Key Set *OryHydraClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version. *OryHydraClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status *OryHydraClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status *OryHydraClient::OAuth2Api* | [**accept_o_auth2_consent_request**](docs/OAuth2Api.md#accept_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request *OryHydraClient::OAuth2Api* | [**accept_o_auth2_login_request**](docs/OAuth2Api.md#accept_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request *OryHydraClient::OAuth2Api* | [**accept_o_auth2_logout_request**](docs/OAuth2Api.md#accept_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request *OryHydraClient::OAuth2Api* | [**create_o_auth2_client**](docs/OAuth2Api.md#create_o_auth2_client) | **POST** /admin/clients | Create OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**delete_o_auth2_client**](docs/OAuth2Api.md#delete_o_auth2_client) | **DELETE** /admin/clients/{id} | Delete OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**delete_o_auth2_token**](docs/OAuth2Api.md#delete_o_auth2_token) | **DELETE** /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**delete_trusted_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#delete_trusted_o_auth2_jwt_grant_issuer) | **DELETE** /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer *OryHydraClient::OAuth2Api* | [**get_o_auth2_client**](docs/OAuth2Api.md#get_o_auth2_client) | **GET** /admin/clients/{id} | Get an OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**get_o_auth2_consent_request**](docs/OAuth2Api.md#get_o_auth2_consent_request) | **GET** /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request *OryHydraClient::OAuth2Api* | [**get_o_auth2_login_request**](docs/OAuth2Api.md#get_o_auth2_login_request) | **GET** /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request *OryHydraClient::OAuth2Api* | [**get_o_auth2_logout_request**](docs/OAuth2Api.md#get_o_auth2_logout_request) | **GET** /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request *OryHydraClient::OAuth2Api* | [**get_trusted_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#get_trusted_o_auth2_jwt_grant_issuer) | **GET** /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer *OryHydraClient::OAuth2Api* | [**introspect_o_auth2_token**](docs/OAuth2Api.md#introspect_o_auth2_token) | **POST** /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens *OryHydraClient::OAuth2Api* | [**list_o_auth2_clients**](docs/OAuth2Api.md#list_o_auth2_clients) | **GET** /admin/clients | List OAuth 2.0 Clients *OryHydraClient::OAuth2Api* | [**list_o_auth2_consent_sessions**](docs/OAuth2Api.md#list_o_auth2_consent_sessions) | **GET** /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject *OryHydraClient::OAuth2Api* | [**list_trusted_o_auth2_jwt_grant_issuers**](docs/OAuth2Api.md#list_trusted_o_auth2_jwt_grant_issuers) | **GET** /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers *OryHydraClient::OAuth2Api* | [**o_auth2_authorize**](docs/OAuth2Api.md#o_auth2_authorize) | **GET** /oauth2/auth | OAuth 2.0 Authorize Endpoint *OryHydraClient::OAuth2Api* | [**oauth2_token_exchange**](docs/OAuth2Api.md#oauth2_token_exchange) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint *OryHydraClient::OAuth2Api* | [**patch_o_auth2_client**](docs/OAuth2Api.md#patch_o_auth2_client) | **PATCH** /admin/clients/{id} | Patch OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**reject_o_auth2_consent_request**](docs/OAuth2Api.md#reject_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request *OryHydraClient::OAuth2Api* | [**reject_o_auth2_login_request**](docs/OAuth2Api.md#reject_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request *OryHydraClient::OAuth2Api* | [**reject_o_auth2_logout_request**](docs/OAuth2Api.md#reject_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request *OryHydraClient::OAuth2Api* | [**revoke_o_auth2_consent_sessions**](docs/OAuth2Api.md#revoke_o_auth2_consent_sessions) | **DELETE** /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject *OryHydraClient::OAuth2Api* | [**revoke_o_auth2_login_sessions**](docs/OAuth2Api.md#revoke_o_auth2_login_sessions) | **DELETE** /admin/oauth2/auth/sessions/login | Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID *OryHydraClient::OAuth2Api* | [**revoke_o_auth2_token**](docs/OAuth2Api.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token *OryHydraClient::OAuth2Api* | [**set_o_auth2_client**](docs/OAuth2Api.md#set_o_auth2_client) | **PUT** /admin/clients/{id} | Set OAuth 2.0 Client *OryHydraClient::OAuth2Api* | [**set_o_auth2_client_lifespans**](docs/OAuth2Api.md#set_o_auth2_client_lifespans) | **PUT** /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans *OryHydraClient::OAuth2Api* | [**trust_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#trust_o_auth2_jwt_grant_issuer) | **POST** /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer *OryHydraClient::OidcApi* | [**create_oidc_dynamic_client**](docs/OidcApi.md#create_oidc_dynamic_client) | **POST** /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration *OryHydraClient::OidcApi* | [**create_verifiable_credential**](docs/OidcApi.md#create_verifiable_credential) | **POST** /credentials | Issues a Verifiable Credential *OryHydraClient::OidcApi* | [**delete_oidc_dynamic_client**](docs/OidcApi.md#delete_oidc_dynamic_client) | **DELETE** /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol *OryHydraClient::OidcApi* | [**discover_oidc_configuration**](docs/OidcApi.md#discover_oidc_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery *OryHydraClient::OidcApi* | [**get_oidc_dynamic_client**](docs/OidcApi.md#get_oidc_dynamic_client) | **GET** /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration *OryHydraClient::OidcApi* | [**get_oidc_user_info**](docs/OidcApi.md#get_oidc_user_info) | **GET** /userinfo | OpenID Connect Userinfo *OryHydraClient::OidcApi* | [**revoke_oidc_session**](docs/OidcApi.md#revoke_oidc_session) | **GET** /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout *OryHydraClient::OidcApi* | [**set_oidc_dynamic_client**](docs/OidcApi.md#set_oidc_dynamic_client) | **PUT** /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration *OryHydraClient::WellknownApi* | [**discover_json_web_keys**](docs/WellknownApi.md#discover_json_web_keys) | **GET** /.well-known/jwks.json | Discover Well-Known JSON Web Keys ## Documentation for Models - [OryHydraClient::AcceptOAuth2ConsentRequest](docs/AcceptOAuth2ConsentRequest.md) - [OryHydraClient::AcceptOAuth2ConsentRequestSession](docs/AcceptOAuth2ConsentRequestSession.md) - [OryHydraClient::AcceptOAuth2LoginRequest](docs/AcceptOAuth2LoginRequest.md) - [OryHydraClient::CreateJsonWebKeySet](docs/CreateJsonWebKeySet.md) - [OryHydraClient::CreateVerifiableCredentialRequestBody](docs/CreateVerifiableCredentialRequestBody.md) - [OryHydraClient::CredentialSupportedDraft00](docs/CredentialSupportedDraft00.md) - [OryHydraClient::ErrorOAuth2](docs/ErrorOAuth2.md) - [OryHydraClient::GenericError](docs/GenericError.md) - [OryHydraClient::GetVersion200Response](docs/GetVersion200Response.md) - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md) - [OryHydraClient::HealthStatus](docs/HealthStatus.md) - [OryHydraClient::IntrospectedOAuth2Token](docs/IntrospectedOAuth2Token.md) - [OryHydraClient::IsReady200Response](docs/IsReady200Response.md) - [OryHydraClient::IsReady503Response](docs/IsReady503Response.md) - [OryHydraClient::JsonPatch](docs/JsonPatch.md) - [OryHydraClient::JsonWebKey](docs/JsonWebKey.md) - [OryHydraClient::JsonWebKeySet](docs/JsonWebKeySet.md) - [OryHydraClient::OAuth2Client](docs/OAuth2Client.md) - [OryHydraClient::OAuth2ClientTokenLifespans](docs/OAuth2ClientTokenLifespans.md) - [OryHydraClient::OAuth2ConsentRequest](docs/OAuth2ConsentRequest.md) - [OryHydraClient::OAuth2ConsentRequestOpenIDConnectContext](docs/OAuth2ConsentRequestOpenIDConnectContext.md) - [OryHydraClient::OAuth2ConsentSession](docs/OAuth2ConsentSession.md) - [OryHydraClient::OAuth2ConsentSessionExpiresAt](docs/OAuth2ConsentSessionExpiresAt.md) - [OryHydraClient::OAuth2LoginRequest](docs/OAuth2LoginRequest.md) - [OryHydraClient::OAuth2LogoutRequest](docs/OAuth2LogoutRequest.md) - [OryHydraClient::OAuth2RedirectTo](docs/OAuth2RedirectTo.md) - [OryHydraClient::OAuth2TokenExchange](docs/OAuth2TokenExchange.md) - [OryHydraClient::OidcConfiguration](docs/OidcConfiguration.md) - [OryHydraClient::OidcUserInfo](docs/OidcUserInfo.md) - [OryHydraClient::Pagination](docs/Pagination.md) - [OryHydraClient::PaginationHeaders](docs/PaginationHeaders.md) - [OryHydraClient::RFC6749ErrorJson](docs/RFC6749ErrorJson.md) - [OryHydraClient::RejectOAuth2Request](docs/RejectOAuth2Request.md) - [OryHydraClient::TokenPagination](docs/TokenPagination.md) - [OryHydraClient::TokenPaginationHeaders](docs/TokenPaginationHeaders.md) - [OryHydraClient::TokenPaginationRequestParameters](docs/TokenPaginationRequestParameters.md) - [OryHydraClient::TokenPaginationResponseHeaders](docs/TokenPaginationResponseHeaders.md) - [OryHydraClient::TrustOAuth2JwtGrantIssuer](docs/TrustOAuth2JwtGrantIssuer.md) - [OryHydraClient::TrustedOAuth2JwtGrantIssuer](docs/TrustedOAuth2JwtGrantIssuer.md) - [OryHydraClient::TrustedOAuth2JwtGrantJsonWebKey](docs/TrustedOAuth2JwtGrantJsonWebKey.md) - [OryHydraClient::VerifiableCredentialPrimingResponse](docs/VerifiableCredentialPrimingResponse.md) - [OryHydraClient::VerifiableCredentialProof](docs/VerifiableCredentialProof.md) - [OryHydraClient::VerifiableCredentialResponse](docs/VerifiableCredentialResponse.md) - [OryHydraClient::Version](docs/Version.md) ## Documentation for Authorization Authentication schemes defined for the API: ### basic - **Type**: HTTP basic authentication ### bearer - **Type**: Bearer authentication ### oauth2 - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: https://hydra.demo.ory.sh/oauth2/auth - **Scopes**: - offline: A scope required when requesting refresh tokens (alias for `offline_access`) - offline_access: A scope required when requesting refresh tokens - openid: Request an OpenID Connect ID Token