# 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.11 - Package version: v0.0.1-alpha.11 - 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.11.gem ``` (for development, run `gem install --dev ./ory-client-v0.0.1-alpha.11.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.11' ### 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' # Setup authorization OryHydraClient.configure do |config| # Configure Bearer authorization: oryToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryHydraClient::DefaultApi.new opts = { create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity | } begin #Create an Identity result = api_instance.create_identity_admin(opts) p result rescue OryHydraClient::ApiError => e puts "Exception when calling DefaultApi->create_identity_admin: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *https://playground.projects.oryapis.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OryHydraClient::DefaultApi* | [**create_identity_admin**](docs/DefaultApi.md#create_identity_admin) | **POST** /api/kratos/admin/identities | Create an Identity *OryHydraClient::DefaultApi* | [**create_recovery_link_admin**](docs/DefaultApi.md#create_recovery_link_admin) | **POST** /api/kratos/admin/recovery/link | Create a Recovery Link *OryHydraClient::DefaultApi* | [**delete_identity_admin**](docs/DefaultApi.md#delete_identity_admin) | **DELETE** /api/kratos/admin/identities/{id} | Delete an Identity *OryHydraClient::DefaultApi* | [**get_identity_admin**](docs/DefaultApi.md#get_identity_admin) | **GET** /api/kratos/admin/identities/{id} | Get an Identity *OryHydraClient::DefaultApi* | [**get_schema**](docs/DefaultApi.md#get_schema) | **GET** /api/kratos/public/schemas/{id} | *OryHydraClient::DefaultApi* | [**get_schema_admin**](docs/DefaultApi.md#get_schema_admin) | **GET** /api/kratos/admin/schemas/{id} | *OryHydraClient::DefaultApi* | [**get_self_service_error**](docs/DefaultApi.md#get_self_service_error) | **GET** /api/kratos/public/self-service/errors | Get User-Facing Self-Service Errors *OryHydraClient::DefaultApi* | [**get_self_service_error_admin**](docs/DefaultApi.md#get_self_service_error_admin) | **GET** /api/kratos/admin/self-service/errors | Get User-Facing Self-Service Errors *OryHydraClient::DefaultApi* | [**get_self_service_login_flow**](docs/DefaultApi.md#get_self_service_login_flow) | **GET** /api/kratos/public/self-service/login/flows | Get Login Flow *OryHydraClient::DefaultApi* | [**get_self_service_login_flow_admin**](docs/DefaultApi.md#get_self_service_login_flow_admin) | **GET** /api/kratos/admin/self-service/login/flows | Get Login Flow *OryHydraClient::DefaultApi* | [**get_self_service_recovery_flow**](docs/DefaultApi.md#get_self_service_recovery_flow) | **GET** /api/kratos/public/self-service/recovery/flows | Get information about a recovery flow *OryHydraClient::DefaultApi* | [**get_self_service_recovery_flow_admin**](docs/DefaultApi.md#get_self_service_recovery_flow_admin) | **GET** /api/kratos/admin/self-service/recovery/flows | Get information about a recovery flow *OryHydraClient::DefaultApi* | [**get_self_service_registration_flow**](docs/DefaultApi.md#get_self_service_registration_flow) | **GET** /api/kratos/public/self-service/registration/flows | Get Registration Flow *OryHydraClient::DefaultApi* | [**get_self_service_registration_flow_admin**](docs/DefaultApi.md#get_self_service_registration_flow_admin) | **GET** /api/kratos/admin/self-service/registration/flows | Get Registration Flow *OryHydraClient::DefaultApi* | [**get_self_service_settings_flow**](docs/DefaultApi.md#get_self_service_settings_flow) | **GET** /api/kratos/public/self-service/settings/flows | Get Settings Flow *OryHydraClient::DefaultApi* | [**get_self_service_settings_flow_admin**](docs/DefaultApi.md#get_self_service_settings_flow_admin) | **GET** /api/kratos/admin/self-service/settings/flows | Get Settings Flow *OryHydraClient::DefaultApi* | [**get_self_service_verification_flow**](docs/DefaultApi.md#get_self_service_verification_flow) | **GET** /api/kratos/public/self-service/verification/flows | Get Verification Flow *OryHydraClient::DefaultApi* | [**get_self_service_verification_flow_admin**](docs/DefaultApi.md#get_self_service_verification_flow_admin) | **GET** /api/kratos/admin/self-service/verification/flows | Get Verification Flow *OryHydraClient::DefaultApi* | [**get_version_admin**](docs/DefaultApi.md#get_version_admin) | **GET** /api/kratos/admin/version | Return Running Software Version. *OryHydraClient::DefaultApi* | [**initialize_self_service_browser_logout_flow**](docs/DefaultApi.md#initialize_self_service_browser_logout_flow) | **GET** /api/kratos/public/self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow *OryHydraClient::DefaultApi* | [**initialize_self_service_login_for_browsers**](docs/DefaultApi.md#initialize_self_service_login_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers *OryHydraClient::DefaultApi* | [**initialize_self_service_login_without_browser**](docs/DefaultApi.md#initialize_self_service_login_without_browser) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... *OryHydraClient::DefaultApi* | [**initialize_self_service_recovery_for_browsers**](docs/DefaultApi.md#initialize_self_service_recovery_for_browsers) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browser Clients *OryHydraClient::DefaultApi* | [**initialize_self_service_recovery_for_native_apps**](docs/DefaultApi.md#initialize_self_service_recovery_for_native_apps) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for Native Apps and API clients *OryHydraClient::DefaultApi* | [**initialize_self_service_registration_for_browsers**](docs/DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers *OryHydraClient::DefaultApi* | [**initialize_self_service_registration_without_browser**](docs/DefaultApi.md#initialize_self_service_registration_without_browser) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... *OryHydraClient::DefaultApi* | [**initialize_self_service_settings_for_browsers**](docs/DefaultApi.md#initialize_self_service_settings_for_browsers) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers *OryHydraClient::DefaultApi* | [**initialize_self_service_settings_for_native_apps**](docs/DefaultApi.md#initialize_self_service_settings_for_native_apps) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for Native Apps and API clients *OryHydraClient::DefaultApi* | [**initialize_self_service_verification_for_browsers**](docs/DefaultApi.md#initialize_self_service_verification_for_browsers) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients *OryHydraClient::DefaultApi* | [**initialize_self_service_verification_for_native_apps**](docs/DefaultApi.md#initialize_self_service_verification_for_native_apps) | **GET** /api/kratos/public/self-service/verification/api | Initialize Verification Flow for Native Apps and API clients *OryHydraClient::DefaultApi* | [**is_alive_admin**](docs/DefaultApi.md#is_alive_admin) | **GET** /api/kratos/admin/health/alive | Check HTTP Server Status *OryHydraClient::DefaultApi* | [**is_ready_admin**](docs/DefaultApi.md#is_ready_admin) | **GET** /api/kratos/admin/health/ready | Check HTTP Server and Database Status *OryHydraClient::DefaultApi* | [**list_identities_admin**](docs/DefaultApi.md#list_identities_admin) | **GET** /api/kratos/admin/identities | List Identities *OryHydraClient::DefaultApi* | [**prometheus_admin**](docs/DefaultApi.md#prometheus_admin) | **GET** /api/kratos/admin/metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so: *OryHydraClient::DefaultApi* | [**revoke_session**](docs/DefaultApi.md#revoke_session) | **DELETE** /api/kratos/public/sessions | Initialize Logout Flow for API Clients - Revoke a Session *OryHydraClient::DefaultApi* | [**submit_self_service_login_flow**](docs/DefaultApi.md#submit_self_service_login_flow) | **POST** /api/kratos/public/self-service/login | Submit a Login Flow *OryHydraClient::DefaultApi* | [**submit_self_service_recovery_flow**](docs/DefaultApi.md#submit_self_service_recovery_flow) | **POST** /api/kratos/public/self-service/recovery | Complete Recovery Flow *OryHydraClient::DefaultApi* | [**submit_self_service_recovery_flow_with_link_method**](docs/DefaultApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /api/kratos/public/self-service/recovery/methods/link | Complete Recovery Flow with Link Method *OryHydraClient::DefaultApi* | [**submit_self_service_registration_flow**](docs/DefaultApi.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow *OryHydraClient::DefaultApi* | [**submit_self_service_settings_flow**](docs/DefaultApi.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow *OryHydraClient::DefaultApi* | [**submit_self_service_verification_flow**](docs/DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification/flows | Complete Verification Flow *OryHydraClient::DefaultApi* | [**to_session**](docs/DefaultApi.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To *OryHydraClient::DefaultApi* | [**update_identity_admin**](docs/DefaultApi.md#update_identity_admin) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity ## Documentation for Models - [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::CreateIdentity](docs/CreateIdentity.md) - [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.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::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::LoginFlow](docs/LoginFlow.md) - [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.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::RecoveryFlow](docs/RecoveryFlow.md) - [OryHydraClient::RecoveryLink](docs/RecoveryLink.md) - [OryHydraClient::RegistrationFlow](docs/RegistrationFlow.md) - [OryHydraClient::RegistrationViaApiResponse](docs/RegistrationViaApiResponse.md) - [OryHydraClient::RevokeSession](docs/RevokeSession.md) - [OryHydraClient::SelfServiceErrorContainer](docs/SelfServiceErrorContainer.md) - [OryHydraClient::ServiceUpdateResponse](docs/ServiceUpdateResponse.md) - [OryHydraClient::Session](docs/Session.md) - [OryHydraClient::SettingsFlow](docs/SettingsFlow.md) - [OryHydraClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md) - [OryHydraClient::SettingsViaApiResponse](docs/SettingsViaApiResponse.md) - [OryHydraClient::SubmitSelfServiceBrowserSettingsOIDCFlowPayload](docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md) - [OryHydraClient::SubmitSelfServiceLoginFlow](docs/SubmitSelfServiceLoginFlow.md) - [OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod](docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md) - [OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod](docs/SubmitSelfServiceRecoveryFlowWithLinkMethod.md) - [OryHydraClient::SubmitSelfServiceRegistrationFlow](docs/SubmitSelfServiceRegistrationFlow.md) - [OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md) - [OryHydraClient::SubmitSelfServiceSettingsFlow](docs/SubmitSelfServiceSettingsFlow.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod](docs/SubmitSelfServiceSettingsFlowWithPasswordMethod.md) - [OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethod](docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md) - [OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethod](docs/SubmitSelfServiceVerificationFlowWithLinkMethod.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::UpdateIdentity](docs/UpdateIdentity.md) - [OryHydraClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md) - [OryHydraClient::VerificationFlow](docs/VerificationFlow.md) - [OryHydraClient::Version](docs/Version.md) - [OryHydraClient::Volume](docs/Volume.md) - [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md) ## Documentation for Authorization ### oryToken - **Type**: Bearer authentication ### sessionCookie - **Type**: API key - **API key parameter name**: ory_kratos_session - **Location**: ### sessionToken - **Type**: Bearer authentication