# ory-kratos-client OryKratosClient - the Ruby gem for the Ory Kratos API Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v0.7.6-alpha.1 - Package version: v0.7.6-alpha.1 - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation ### Build a gem To build the Ruby code into a gem: ```shell gem build ory-kratos-client.gemspec ``` Then either install the gem locally: ```shell gem install ./ory-kratos-client-v0.7.6-alpha.1.gem ``` (for development, run `gem install --dev ./ory-kratos-client-v0.7.6-alpha.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-kratos-client', '~> v0.7.6-alpha.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-kratos-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-kratos-client' api_instance = OryKratosClient::MetadataApi.new begin #Return Running Software Version. result = api_instance.get_version p result rescue OryKratosClient::ApiError => e puts "Exception when calling MetadataApi->get_version: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OryKratosClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version. *OryKratosClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status *OryKratosClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status *OryKratosClient::MetadataApi* | [**prometheus**](docs/MetadataApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: *OryKratosClient::V0alpha1Api* | [**admin_create_identity**](docs/V0alpha1Api.md#admin_create_identity) | **POST** /identities | Create an Identity *OryKratosClient::V0alpha1Api* | [**admin_create_self_service_recovery_link**](docs/V0alpha1Api.md#admin_create_self_service_recovery_link) | **POST** /recovery/link | Create a Recovery Link *OryKratosClient::V0alpha1Api* | [**admin_delete_identity**](docs/V0alpha1Api.md#admin_delete_identity) | **DELETE** /identities/{id} | Delete an Identity *OryKratosClient::V0alpha1Api* | [**admin_get_identity**](docs/V0alpha1Api.md#admin_get_identity) | **GET** /identities/{id} | Get an Identity *OryKratosClient::V0alpha1Api* | [**admin_list_identities**](docs/V0alpha1Api.md#admin_list_identities) | **GET** /identities | List Identities *OryKratosClient::V0alpha1Api* | [**admin_update_identity**](docs/V0alpha1Api.md#admin_update_identity) | **PUT** /identities/{id} | Update an Identity *OryKratosClient::V0alpha1Api* | [**create_self_service_logout_flow_url_for_browsers**](docs/V0alpha1Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers *OryKratosClient::V0alpha1Api* | [**get_json_schema**](docs/V0alpha1Api.md#get_json_schema) | **GET** /schemas/{id} | *OryKratosClient::V0alpha1Api* | [**get_self_service_error**](docs/V0alpha1Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors *OryKratosClient::V0alpha1Api* | [**get_self_service_login_flow**](docs/V0alpha1Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow *OryKratosClient::V0alpha1Api* | [**get_self_service_recovery_flow**](docs/V0alpha1Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow *OryKratosClient::V0alpha1Api* | [**get_self_service_registration_flow**](docs/V0alpha1Api.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow *OryKratosClient::V0alpha1Api* | [**get_self_service_settings_flow**](docs/V0alpha1Api.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow *OryKratosClient::V0alpha1Api* | [**get_self_service_verification_flow**](docs/V0alpha1Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow *OryKratosClient::V0alpha1Api* | [**initialize_self_service_login_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for Browsers *OryKratosClient::V0alpha1Api* | [**initialize_self_service_login_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_login_flow_without_browser) | **GET** /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browsers *OryKratosClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**initialize_self_service_registration_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /self-service/registration/browser | Initialize Registration Flow for Browsers *OryKratosClient::V0alpha1Api* | [**initialize_self_service_registration_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**initialize_self_service_settings_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers *OryKratosClient::V0alpha1Api* | [**initialize_self_service_settings_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**initialize_self_service_verification_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients *OryKratosClient::V0alpha1Api* | [**initialize_self_service_verification_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**submit_self_service_login_flow**](docs/V0alpha1Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow *OryKratosClient::V0alpha1Api* | [**submit_self_service_logout_flow**](docs/V0alpha1Api.md#submit_self_service_logout_flow) | **GET** /self-service/logout | Complete Self-Service Logout *OryKratosClient::V0alpha1Api* | [**submit_self_service_logout_flow_without_browser**](docs/V0alpha1Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... *OryKratosClient::V0alpha1Api* | [**submit_self_service_recovery_flow**](docs/V0alpha1Api.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow *OryKratosClient::V0alpha1Api* | [**submit_self_service_registration_flow**](docs/V0alpha1Api.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow *OryKratosClient::V0alpha1Api* | [**submit_self_service_settings_flow**](docs/V0alpha1Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow *OryKratosClient::V0alpha1Api* | [**submit_self_service_verification_flow**](docs/V0alpha1Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow *OryKratosClient::V0alpha1Api* | [**to_session**](docs/V0alpha1Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To ## Documentation for Models - [OryKratosClient::AdminCreateIdentityBody](docs/AdminCreateIdentityBody.md) - [OryKratosClient::AdminCreateSelfServiceRecoveryLinkBody](docs/AdminCreateSelfServiceRecoveryLinkBody.md) - [OryKratosClient::AdminUpdateIdentityBody](docs/AdminUpdateIdentityBody.md) - [OryKratosClient::GenericError](docs/GenericError.md) - [OryKratosClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md) - [OryKratosClient::HealthStatus](docs/HealthStatus.md) - [OryKratosClient::Identity](docs/Identity.md) - [OryKratosClient::IdentityCredentials](docs/IdentityCredentials.md) - [OryKratosClient::IdentityState](docs/IdentityState.md) - [OryKratosClient::InlineResponse200](docs/InlineResponse200.md) - [OryKratosClient::InlineResponse2001](docs/InlineResponse2001.md) - [OryKratosClient::InlineResponse503](docs/InlineResponse503.md) - [OryKratosClient::JsonError](docs/JsonError.md) - [OryKratosClient::Meta](docs/Meta.md) - [OryKratosClient::RecoveryAddress](docs/RecoveryAddress.md) - [OryKratosClient::SelfServiceError](docs/SelfServiceError.md) - [OryKratosClient::SelfServiceLoginFlow](docs/SelfServiceLoginFlow.md) - [OryKratosClient::SelfServiceLogoutUrl](docs/SelfServiceLogoutUrl.md) - [OryKratosClient::SelfServiceRecoveryFlow](docs/SelfServiceRecoveryFlow.md) - [OryKratosClient::SelfServiceRecoveryFlowState](docs/SelfServiceRecoveryFlowState.md) - [OryKratosClient::SelfServiceRecoveryLink](docs/SelfServiceRecoveryLink.md) - [OryKratosClient::SelfServiceRegistrationFlow](docs/SelfServiceRegistrationFlow.md) - [OryKratosClient::SelfServiceSettingsFlow](docs/SelfServiceSettingsFlow.md) - [OryKratosClient::SelfServiceSettingsFlowState](docs/SelfServiceSettingsFlowState.md) - [OryKratosClient::SelfServiceVerificationFlow](docs/SelfServiceVerificationFlow.md) - [OryKratosClient::SelfServiceVerificationFlowState](docs/SelfServiceVerificationFlowState.md) - [OryKratosClient::Session](docs/Session.md) - [OryKratosClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md) - [OryKratosClient::SubmitSelfServiceLoginFlowBody](docs/SubmitSelfServiceLoginFlowBody.md) - [OryKratosClient::SubmitSelfServiceLoginFlowWithOidcMethodBody](docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md) - [OryKratosClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody](docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md) - [OryKratosClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody](docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md) - [OryKratosClient::SubmitSelfServiceRecoveryFlowBody](docs/SubmitSelfServiceRecoveryFlowBody.md) - [OryKratosClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody](docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md) - [OryKratosClient::SubmitSelfServiceRegistrationFlowBody](docs/SubmitSelfServiceRegistrationFlowBody.md) - [OryKratosClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody](docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md) - [OryKratosClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md) - [OryKratosClient::SubmitSelfServiceSettingsFlowBody](docs/SubmitSelfServiceSettingsFlowBody.md) - [OryKratosClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody](docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md) - [OryKratosClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody](docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md) - [OryKratosClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody](docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md) - [OryKratosClient::SubmitSelfServiceVerificationFlowBody](docs/SubmitSelfServiceVerificationFlowBody.md) - [OryKratosClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody](docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md) - [OryKratosClient::SuccessfulSelfServiceLoginWithoutBrowser](docs/SuccessfulSelfServiceLoginWithoutBrowser.md) - [OryKratosClient::SuccessfulSelfServiceRegistrationWithoutBrowser](docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md) - [OryKratosClient::SuccessfulSelfServiceSettingsWithoutBrowser](docs/SuccessfulSelfServiceSettingsWithoutBrowser.md) - [OryKratosClient::UiContainer](docs/UiContainer.md) - [OryKratosClient::UiNode](docs/UiNode.md) - [OryKratosClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md) - [OryKratosClient::UiNodeAttributes](docs/UiNodeAttributes.md) - [OryKratosClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md) - [OryKratosClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md) - [OryKratosClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md) - [OryKratosClient::UiText](docs/UiText.md) - [OryKratosClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md) - [OryKratosClient::Version](docs/Version.md) ## Documentation for Authorization ### oryAccessToken - **Type**: API key - **API key parameter name**: Authorization - **Location**: HTTP header