# ory-client OryHydraClient - the Ruby gem for the Ory APIs Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v0.0.1-alpha.16 - Package version: v0.0.1-alpha.16 - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation ### Build a gem To build the Ruby code into a gem: ```shell gem build ory-client.gemspec ``` Then either install the gem locally: ```shell gem install ./ory-client-v0.0.1-alpha.16.gem ``` (for development, run `gem install --dev ./ory-client-v0.0.1-alpha.16.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-client', '~> v0.0.1-alpha.16' ### 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-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-client' api_instance = OryHydraClient::MetadataApi.new begin #Return Running Software Version. result = api_instance.get_version p result rescue OryHydraClient::ApiError => e puts "Exception when calling MetadataApi->get_version: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *https://playground.projects.oryapis.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OryHydraClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /api/kratos/public/version | Return Running Software Version. *OryHydraClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /api/kratos/public/health/alive | Check HTTP Server Status *OryHydraClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /api/kratos/public/health/ready | Check HTTP Server and Database Status *OryHydraClient::MetadataApi* | [**prometheus**](docs/MetadataApi.md#prometheus) | **GET** /api/kratos/public/metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: *OryHydraClient::V0alpha1Api* | [**admin_create_identity**](docs/V0alpha1Api.md#admin_create_identity) | **POST** /api/kratos/admin/identities | Create an Identity *OryHydraClient::V0alpha1Api* | [**admin_create_self_service_recovery_link**](docs/V0alpha1Api.md#admin_create_self_service_recovery_link) | **POST** /api/kratos/admin/recovery/link | Create a Recovery Link *OryHydraClient::V0alpha1Api* | [**admin_delete_identity**](docs/V0alpha1Api.md#admin_delete_identity) | **DELETE** /api/kratos/admin/identities/{id} | Delete an Identity *OryHydraClient::V0alpha1Api* | [**admin_get_identity**](docs/V0alpha1Api.md#admin_get_identity) | **GET** /api/kratos/admin/identities/{id} | Get an Identity *OryHydraClient::V0alpha1Api* | [**admin_list_identities**](docs/V0alpha1Api.md#admin_list_identities) | **GET** /api/kratos/admin/identities | List Identities *OryHydraClient::V0alpha1Api* | [**admin_update_identity**](docs/V0alpha1Api.md#admin_update_identity) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity *OryHydraClient::V0alpha1Api* | [**create_self_service_logout_flow_url_for_browsers**](docs/V0alpha1Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /api/kratos/public/self-service/logout/browser | Create a Logout URL for Browsers *OryHydraClient::V0alpha1Api* | [**get_json_schema**](docs/V0alpha1Api.md#get_json_schema) | **GET** /api/kratos/public/schemas/{id} | *OryHydraClient::V0alpha1Api* | [**get_self_service_error**](docs/V0alpha1Api.md#get_self_service_error) | **GET** /api/kratos/public/self-service/errors | Get Self-Service Errors *OryHydraClient::V0alpha1Api* | [**get_self_service_login_flow**](docs/V0alpha1Api.md#get_self_service_login_flow) | **GET** /api/kratos/public/self-service/login/flows | Get Login Flow *OryHydraClient::V0alpha1Api* | [**get_self_service_recovery_flow**](docs/V0alpha1Api.md#get_self_service_recovery_flow) | **GET** /api/kratos/public/self-service/recovery/flows | Get Recovery Flow *OryHydraClient::V0alpha1Api* | [**get_self_service_registration_flow**](docs/V0alpha1Api.md#get_self_service_registration_flow) | **GET** /api/kratos/public/self-service/registration/flows | Get Registration Flow *OryHydraClient::V0alpha1Api* | [**get_self_service_settings_flow**](docs/V0alpha1Api.md#get_self_service_settings_flow) | **GET** /api/kratos/public/self-service/settings/flows | Get Settings Flow *OryHydraClient::V0alpha1Api* | [**get_self_service_verification_flow**](docs/V0alpha1Api.md#get_self_service_verification_flow) | **GET** /api/kratos/public/self-service/verification/flows | Get Verification Flow *OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers *OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_login_flow_without_browser) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browsers *OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers *OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers *OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients *OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /api/kratos/public/self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**submit_self_service_login_flow**](docs/V0alpha1Api.md#submit_self_service_login_flow) | **POST** /api/kratos/public/self-service/login | Submit a Login Flow *OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow**](docs/V0alpha1Api.md#submit_self_service_logout_flow) | **GET** /api/kratos/public/self-service/logout | Complete Self-Service Logout *OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow_without_browser**](docs/V0alpha1Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /api/kratos/public/self-service/logout/api | Perform Logout for APIs, Services, Apps, ... *OryHydraClient::V0alpha1Api* | [**submit_self_service_recovery_flow**](docs/V0alpha1Api.md#submit_self_service_recovery_flow) | **POST** /api/kratos/public/self-service/recovery | Complete Recovery Flow *OryHydraClient::V0alpha1Api* | [**submit_self_service_registration_flow**](docs/V0alpha1Api.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow *OryHydraClient::V0alpha1Api* | [**submit_self_service_settings_flow**](docs/V0alpha1Api.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow *OryHydraClient::V0alpha1Api* | [**submit_self_service_verification_flow**](docs/V0alpha1Api.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification | Complete Verification Flow *OryHydraClient::V0alpha1Api* | [**to_session**](docs/V0alpha1Api.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To ## Documentation for Models - [OryHydraClient::AdminCreateIdentityBody](docs/AdminCreateIdentityBody.md) - [OryHydraClient::AdminCreateSelfServiceRecoveryLinkBody](docs/AdminCreateSelfServiceRecoveryLinkBody.md) - [OryHydraClient::AdminUpdateIdentityBody](docs/AdminUpdateIdentityBody.md) - [OryHydraClient::AuthenticateOKBody](docs/AuthenticateOKBody.md) - [OryHydraClient::ContainerChangeResponseItem](docs/ContainerChangeResponseItem.md) - [OryHydraClient::ContainerCreateCreatedBody](docs/ContainerCreateCreatedBody.md) - [OryHydraClient::ContainerTopOKBody](docs/ContainerTopOKBody.md) - [OryHydraClient::ContainerUpdateOKBody](docs/ContainerUpdateOKBody.md) - [OryHydraClient::ContainerWaitOKBody](docs/ContainerWaitOKBody.md) - [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md) - [OryHydraClient::ErrorResponse](docs/ErrorResponse.md) - [OryHydraClient::GenericError](docs/GenericError.md) - [OryHydraClient::GraphDriverData](docs/GraphDriverData.md) - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md) - [OryHydraClient::HealthStatus](docs/HealthStatus.md) - [OryHydraClient::IdResponse](docs/IdResponse.md) - [OryHydraClient::Identity](docs/Identity.md) - [OryHydraClient::IdentityCredentials](docs/IdentityCredentials.md) - [OryHydraClient::IdentityState](docs/IdentityState.md) - [OryHydraClient::ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md) - [OryHydraClient::ImageSummary](docs/ImageSummary.md) - [OryHydraClient::InlineResponse200](docs/InlineResponse200.md) - [OryHydraClient::InlineResponse2001](docs/InlineResponse2001.md) - [OryHydraClient::InlineResponse503](docs/InlineResponse503.md) - [OryHydraClient::JsonError](docs/JsonError.md) - [OryHydraClient::Meta](docs/Meta.md) - [OryHydraClient::Plugin](docs/Plugin.md) - [OryHydraClient::PluginConfig](docs/PluginConfig.md) - [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md) - [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md) - [OryHydraClient::PluginConfigLinux](docs/PluginConfigLinux.md) - [OryHydraClient::PluginConfigNetwork](docs/PluginConfigNetwork.md) - [OryHydraClient::PluginConfigRootfs](docs/PluginConfigRootfs.md) - [OryHydraClient::PluginConfigUser](docs/PluginConfigUser.md) - [OryHydraClient::PluginDevice](docs/PluginDevice.md) - [OryHydraClient::PluginEnv](docs/PluginEnv.md) - [OryHydraClient::PluginInterfaceType](docs/PluginInterfaceType.md) - [OryHydraClient::PluginMount](docs/PluginMount.md) - [OryHydraClient::PluginSettings](docs/PluginSettings.md) - [OryHydraClient::Port](docs/Port.md) - [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md) - [OryHydraClient::SelfServiceError](docs/SelfServiceError.md) - [OryHydraClient::SelfServiceLoginFlow](docs/SelfServiceLoginFlow.md) - [OryHydraClient::SelfServiceLogoutUrl](docs/SelfServiceLogoutUrl.md) - [OryHydraClient::SelfServiceRecoveryFlow](docs/SelfServiceRecoveryFlow.md) - [OryHydraClient::SelfServiceRecoveryFlowState](docs/SelfServiceRecoveryFlowState.md) - [OryHydraClient::SelfServiceRecoveryLink](docs/SelfServiceRecoveryLink.md) - [OryHydraClient::SelfServiceRegistrationFlow](docs/SelfServiceRegistrationFlow.md) - [OryHydraClient::SelfServiceSettingsFlow](docs/SelfServiceSettingsFlow.md) - [OryHydraClient::SelfServiceSettingsFlowState](docs/SelfServiceSettingsFlowState.md) - [OryHydraClient::SelfServiceVerificationFlow](docs/SelfServiceVerificationFlow.md) - [OryHydraClient::SelfServiceVerificationFlowState](docs/SelfServiceVerificationFlowState.md) - [OryHydraClient::ServiceUpdateResponse](docs/ServiceUpdateResponse.md) - [OryHydraClient::Session](docs/Session.md) - [OryHydraClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md) - [OryHydraClient::SubmitSelfServiceLoginFlowBody](docs/SubmitSelfServiceLoginFlowBody.md) - [OryHydraClient::SubmitSelfServiceLoginFlowWithOidcMethodBody](docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md) - [OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody](docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md) - [OryHydraClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody](docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md) - [OryHydraClient::SubmitSelfServiceRecoveryFlowBody](docs/SubmitSelfServiceRecoveryFlowBody.md) - [OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody](docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md) - [OryHydraClient::SubmitSelfServiceRegistrationFlowBody](docs/SubmitSelfServiceRegistrationFlowBody.md) - [OryHydraClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody](docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md) - [OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowBody](docs/SubmitSelfServiceSettingsFlowBody.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody](docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody](docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody](docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md) - [OryHydraClient::SubmitSelfServiceVerificationFlowBody](docs/SubmitSelfServiceVerificationFlowBody.md) - [OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody](docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md) - [OryHydraClient::SuccessfulSelfServiceLoginWithoutBrowser](docs/SuccessfulSelfServiceLoginWithoutBrowser.md) - [OryHydraClient::SuccessfulSelfServiceRegistrationWithoutBrowser](docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md) - [OryHydraClient::SuccessfulSelfServiceSettingsWithoutBrowser](docs/SuccessfulSelfServiceSettingsWithoutBrowser.md) - [OryHydraClient::UiContainer](docs/UiContainer.md) - [OryHydraClient::UiNode](docs/UiNode.md) - [OryHydraClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md) - [OryHydraClient::UiNodeAttributes](docs/UiNodeAttributes.md) - [OryHydraClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md) - [OryHydraClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md) - [OryHydraClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md) - [OryHydraClient::UiText](docs/UiText.md) - [OryHydraClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md) - [OryHydraClient::Version](docs/Version.md) - [OryHydraClient::Volume](docs/Volume.md) - [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md) ## Documentation for Authorization ### oryAccessToken - **Type**: Bearer authentication