# ory-kratos-client OryKratosClient - the Ruby gem for the Ory Identities API This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v1.1.0 - Package version: v1.1.0 - 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-v1.1.0.gem ``` (for development, run `gem install --dev ./ory-kratos-client-v1.1.0.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', '~> v1.1.0' ### 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' # Setup authorization OryKratosClient.configure do |config| # Configure API key authorization: oryAccessToken config.api_key['oryAccessToken'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['oryAccessToken'] = 'Bearer' end api_instance = OryKratosClient::CourierApi.new id = 'id_example' # String | MessageID is the ID of the message. begin #Get a Message result = api_instance.get_courier_message(id) p result rescue OryKratosClient::ApiError => e puts "Exception when calling CourierApi->get_courier_message: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OryKratosClient::CourierApi* | [**get_courier_message**](docs/CourierApi.md#get_courier_message) | **GET** /admin/courier/messages/{id} | Get a Message *OryKratosClient::CourierApi* | [**list_courier_messages**](docs/CourierApi.md#list_courier_messages) | **GET** /admin/courier/messages | List Messages *OryKratosClient::FrontendApi* | [**create_browser_login_flow**](docs/FrontendApi.md#create_browser_login_flow) | **GET** /self-service/login/browser | Create Login Flow for Browsers *OryKratosClient::FrontendApi* | [**create_browser_logout_flow**](docs/FrontendApi.md#create_browser_logout_flow) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers *OryKratosClient::FrontendApi* | [**create_browser_recovery_flow**](docs/FrontendApi.md#create_browser_recovery_flow) | **GET** /self-service/recovery/browser | Create Recovery Flow for Browsers *OryKratosClient::FrontendApi* | [**create_browser_registration_flow**](docs/FrontendApi.md#create_browser_registration_flow) | **GET** /self-service/registration/browser | Create Registration Flow for Browsers *OryKratosClient::FrontendApi* | [**create_browser_settings_flow**](docs/FrontendApi.md#create_browser_settings_flow) | **GET** /self-service/settings/browser | Create Settings Flow for Browsers *OryKratosClient::FrontendApi* | [**create_browser_verification_flow**](docs/FrontendApi.md#create_browser_verification_flow) | **GET** /self-service/verification/browser | Create Verification Flow for Browser Clients *OryKratosClient::FrontendApi* | [**create_native_login_flow**](docs/FrontendApi.md#create_native_login_flow) | **GET** /self-service/login/api | Create Login Flow for Native Apps *OryKratosClient::FrontendApi* | [**create_native_recovery_flow**](docs/FrontendApi.md#create_native_recovery_flow) | **GET** /self-service/recovery/api | Create Recovery Flow for Native Apps *OryKratosClient::FrontendApi* | [**create_native_registration_flow**](docs/FrontendApi.md#create_native_registration_flow) | **GET** /self-service/registration/api | Create Registration Flow for Native Apps *OryKratosClient::FrontendApi* | [**create_native_settings_flow**](docs/FrontendApi.md#create_native_settings_flow) | **GET** /self-service/settings/api | Create Settings Flow for Native Apps *OryKratosClient::FrontendApi* | [**create_native_verification_flow**](docs/FrontendApi.md#create_native_verification_flow) | **GET** /self-service/verification/api | Create Verification Flow for Native Apps *OryKratosClient::FrontendApi* | [**disable_my_other_sessions**](docs/FrontendApi.md#disable_my_other_sessions) | **DELETE** /sessions | Disable my other sessions *OryKratosClient::FrontendApi* | [**disable_my_session**](docs/FrontendApi.md#disable_my_session) | **DELETE** /sessions/{id} | Disable one of my sessions *OryKratosClient::FrontendApi* | [**exchange_session_token**](docs/FrontendApi.md#exchange_session_token) | **GET** /sessions/token-exchange | Exchange Session Token *OryKratosClient::FrontendApi* | [**get_flow_error**](docs/FrontendApi.md#get_flow_error) | **GET** /self-service/errors | Get User-Flow Errors *OryKratosClient::FrontendApi* | [**get_login_flow**](docs/FrontendApi.md#get_login_flow) | **GET** /self-service/login/flows | Get Login Flow *OryKratosClient::FrontendApi* | [**get_recovery_flow**](docs/FrontendApi.md#get_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow *OryKratosClient::FrontendApi* | [**get_registration_flow**](docs/FrontendApi.md#get_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow *OryKratosClient::FrontendApi* | [**get_settings_flow**](docs/FrontendApi.md#get_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow *OryKratosClient::FrontendApi* | [**get_verification_flow**](docs/FrontendApi.md#get_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow *OryKratosClient::FrontendApi* | [**get_web_authn_java_script**](docs/FrontendApi.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript *OryKratosClient::FrontendApi* | [**list_my_sessions**](docs/FrontendApi.md#list_my_sessions) | **GET** /sessions | Get My Active Sessions *OryKratosClient::FrontendApi* | [**perform_native_logout**](docs/FrontendApi.md#perform_native_logout) | **DELETE** /self-service/logout/api | Perform Logout for Native Apps *OryKratosClient::FrontendApi* | [**to_session**](docs/FrontendApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To *OryKratosClient::FrontendApi* | [**update_login_flow**](docs/FrontendApi.md#update_login_flow) | **POST** /self-service/login | Submit a Login Flow *OryKratosClient::FrontendApi* | [**update_logout_flow**](docs/FrontendApi.md#update_logout_flow) | **GET** /self-service/logout | Update Logout Flow *OryKratosClient::FrontendApi* | [**update_recovery_flow**](docs/FrontendApi.md#update_recovery_flow) | **POST** /self-service/recovery | Update Recovery Flow *OryKratosClient::FrontendApi* | [**update_registration_flow**](docs/FrontendApi.md#update_registration_flow) | **POST** /self-service/registration | Update Registration Flow *OryKratosClient::FrontendApi* | [**update_settings_flow**](docs/FrontendApi.md#update_settings_flow) | **POST** /self-service/settings | Complete Settings Flow *OryKratosClient::FrontendApi* | [**update_verification_flow**](docs/FrontendApi.md#update_verification_flow) | **POST** /self-service/verification | Complete Verification Flow *OryKratosClient::IdentityApi* | [**batch_patch_identities**](docs/IdentityApi.md#batch_patch_identities) | **PATCH** /admin/identities | Create and deletes multiple identities *OryKratosClient::IdentityApi* | [**create_identity**](docs/IdentityApi.md#create_identity) | **POST** /admin/identities | Create an Identity *OryKratosClient::IdentityApi* | [**create_recovery_code_for_identity**](docs/IdentityApi.md#create_recovery_code_for_identity) | **POST** /admin/recovery/code | Create a Recovery Code *OryKratosClient::IdentityApi* | [**create_recovery_link_for_identity**](docs/IdentityApi.md#create_recovery_link_for_identity) | **POST** /admin/recovery/link | Create a Recovery Link *OryKratosClient::IdentityApi* | [**delete_identity**](docs/IdentityApi.md#delete_identity) | **DELETE** /admin/identities/{id} | Delete an Identity *OryKratosClient::IdentityApi* | [**delete_identity_credentials**](docs/IdentityApi.md#delete_identity_credentials) | **DELETE** /admin/identities/{id}/credentials/{type} | Delete a credential for a specific identity *OryKratosClient::IdentityApi* | [**delete_identity_sessions**](docs/IdentityApi.md#delete_identity_sessions) | **DELETE** /admin/identities/{id}/sessions | Delete & Invalidate an Identity's Sessions *OryKratosClient::IdentityApi* | [**disable_session**](docs/IdentityApi.md#disable_session) | **DELETE** /admin/sessions/{id} | Deactivate a Session *OryKratosClient::IdentityApi* | [**extend_session**](docs/IdentityApi.md#extend_session) | **PATCH** /admin/sessions/{id}/extend | Extend a Session *OryKratosClient::IdentityApi* | [**get_identity**](docs/IdentityApi.md#get_identity) | **GET** /admin/identities/{id} | Get an Identity *OryKratosClient::IdentityApi* | [**get_identity_schema**](docs/IdentityApi.md#get_identity_schema) | **GET** /schemas/{id} | Get Identity JSON Schema *OryKratosClient::IdentityApi* | [**get_session**](docs/IdentityApi.md#get_session) | **GET** /admin/sessions/{id} | Get Session *OryKratosClient::IdentityApi* | [**list_identities**](docs/IdentityApi.md#list_identities) | **GET** /admin/identities | List Identities *OryKratosClient::IdentityApi* | [**list_identity_schemas**](docs/IdentityApi.md#list_identity_schemas) | **GET** /schemas | Get all Identity Schemas *OryKratosClient::IdentityApi* | [**list_identity_sessions**](docs/IdentityApi.md#list_identity_sessions) | **GET** /admin/identities/{id}/sessions | List an Identity's Sessions *OryKratosClient::IdentityApi* | [**list_sessions**](docs/IdentityApi.md#list_sessions) | **GET** /admin/sessions | List All Sessions *OryKratosClient::IdentityApi* | [**patch_identity**](docs/IdentityApi.md#patch_identity) | **PATCH** /admin/identities/{id} | Patch an Identity *OryKratosClient::IdentityApi* | [**update_identity**](docs/IdentityApi.md#update_identity) | **PUT** /admin/identities/{id} | Update an Identity *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 ## Documentation for Models - [OryKratosClient::AuthenticatorAssuranceLevel](docs/AuthenticatorAssuranceLevel.md) - [OryKratosClient::BatchPatchIdentitiesResponse](docs/BatchPatchIdentitiesResponse.md) - [OryKratosClient::ConsistencyRequestParameters](docs/ConsistencyRequestParameters.md) - [OryKratosClient::ContinueWith](docs/ContinueWith.md) - [OryKratosClient::ContinueWithRecoveryUi](docs/ContinueWithRecoveryUi.md) - [OryKratosClient::ContinueWithRecoveryUiFlow](docs/ContinueWithRecoveryUiFlow.md) - [OryKratosClient::ContinueWithSetOrySessionToken](docs/ContinueWithSetOrySessionToken.md) - [OryKratosClient::ContinueWithSettingsUi](docs/ContinueWithSettingsUi.md) - [OryKratosClient::ContinueWithSettingsUiFlow](docs/ContinueWithSettingsUiFlow.md) - [OryKratosClient::ContinueWithVerificationUi](docs/ContinueWithVerificationUi.md) - [OryKratosClient::ContinueWithVerificationUiFlow](docs/ContinueWithVerificationUiFlow.md) - [OryKratosClient::CourierMessageStatus](docs/CourierMessageStatus.md) - [OryKratosClient::CourierMessageType](docs/CourierMessageType.md) - [OryKratosClient::CreateIdentityBody](docs/CreateIdentityBody.md) - [OryKratosClient::CreateRecoveryCodeForIdentityBody](docs/CreateRecoveryCodeForIdentityBody.md) - [OryKratosClient::CreateRecoveryLinkForIdentityBody](docs/CreateRecoveryLinkForIdentityBody.md) - [OryKratosClient::DeleteMySessionsCount](docs/DeleteMySessionsCount.md) - [OryKratosClient::ErrorAuthenticatorAssuranceLevelNotSatisfied](docs/ErrorAuthenticatorAssuranceLevelNotSatisfied.md) - [OryKratosClient::ErrorBrowserLocationChangeRequired](docs/ErrorBrowserLocationChangeRequired.md) - [OryKratosClient::ErrorFlowReplaced](docs/ErrorFlowReplaced.md) - [OryKratosClient::ErrorGeneric](docs/ErrorGeneric.md) - [OryKratosClient::FlowError](docs/FlowError.md) - [OryKratosClient::GenericError](docs/GenericError.md) - [OryKratosClient::GetVersion200Response](docs/GetVersion200Response.md) - [OryKratosClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md) - [OryKratosClient::HealthStatus](docs/HealthStatus.md) - [OryKratosClient::Identity](docs/Identity.md) - [OryKratosClient::IdentityCredentials](docs/IdentityCredentials.md) - [OryKratosClient::IdentityCredentialsCode](docs/IdentityCredentialsCode.md) - [OryKratosClient::IdentityCredentialsOidc](docs/IdentityCredentialsOidc.md) - [OryKratosClient::IdentityCredentialsOidcProvider](docs/IdentityCredentialsOidcProvider.md) - [OryKratosClient::IdentityCredentialsPassword](docs/IdentityCredentialsPassword.md) - [OryKratosClient::IdentityPatch](docs/IdentityPatch.md) - [OryKratosClient::IdentityPatchResponse](docs/IdentityPatchResponse.md) - [OryKratosClient::IdentitySchemaContainer](docs/IdentitySchemaContainer.md) - [OryKratosClient::IdentityWithCredentials](docs/IdentityWithCredentials.md) - [OryKratosClient::IdentityWithCredentialsOidc](docs/IdentityWithCredentialsOidc.md) - [OryKratosClient::IdentityWithCredentialsOidcConfig](docs/IdentityWithCredentialsOidcConfig.md) - [OryKratosClient::IdentityWithCredentialsOidcConfigProvider](docs/IdentityWithCredentialsOidcConfigProvider.md) - [OryKratosClient::IdentityWithCredentialsPassword](docs/IdentityWithCredentialsPassword.md) - [OryKratosClient::IdentityWithCredentialsPasswordConfig](docs/IdentityWithCredentialsPasswordConfig.md) - [OryKratosClient::IsAlive200Response](docs/IsAlive200Response.md) - [OryKratosClient::IsReady503Response](docs/IsReady503Response.md) - [OryKratosClient::JsonPatch](docs/JsonPatch.md) - [OryKratosClient::LoginFlow](docs/LoginFlow.md) - [OryKratosClient::LoginFlowState](docs/LoginFlowState.md) - [OryKratosClient::LogoutFlow](docs/LogoutFlow.md) - [OryKratosClient::Message](docs/Message.md) - [OryKratosClient::MessageDispatch](docs/MessageDispatch.md) - [OryKratosClient::NeedsPrivilegedSessionError](docs/NeedsPrivilegedSessionError.md) - [OryKratosClient::OAuth2Client](docs/OAuth2Client.md) - [OryKratosClient::OAuth2ConsentRequestOpenIDConnectContext](docs/OAuth2ConsentRequestOpenIDConnectContext.md) - [OryKratosClient::OAuth2LoginRequest](docs/OAuth2LoginRequest.md) - [OryKratosClient::PatchIdentitiesBody](docs/PatchIdentitiesBody.md) - [OryKratosClient::PerformNativeLogoutBody](docs/PerformNativeLogoutBody.md) - [OryKratosClient::RecoveryCodeForIdentity](docs/RecoveryCodeForIdentity.md) - [OryKratosClient::RecoveryFlow](docs/RecoveryFlow.md) - [OryKratosClient::RecoveryFlowState](docs/RecoveryFlowState.md) - [OryKratosClient::RecoveryIdentityAddress](docs/RecoveryIdentityAddress.md) - [OryKratosClient::RecoveryLinkForIdentity](docs/RecoveryLinkForIdentity.md) - [OryKratosClient::RegistrationFlow](docs/RegistrationFlow.md) - [OryKratosClient::RegistrationFlowState](docs/RegistrationFlowState.md) - [OryKratosClient::SelfServiceFlowExpiredError](docs/SelfServiceFlowExpiredError.md) - [OryKratosClient::Session](docs/Session.md) - [OryKratosClient::SessionAuthenticationMethod](docs/SessionAuthenticationMethod.md) - [OryKratosClient::SessionDevice](docs/SessionDevice.md) - [OryKratosClient::SettingsFlow](docs/SettingsFlow.md) - [OryKratosClient::SettingsFlowState](docs/SettingsFlowState.md) - [OryKratosClient::SuccessfulCodeExchangeResponse](docs/SuccessfulCodeExchangeResponse.md) - [OryKratosClient::SuccessfulNativeLogin](docs/SuccessfulNativeLogin.md) - [OryKratosClient::SuccessfulNativeRegistration](docs/SuccessfulNativeRegistration.md) - [OryKratosClient::TokenPagination](docs/TokenPagination.md) - [OryKratosClient::TokenPaginationHeaders](docs/TokenPaginationHeaders.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::UiNodeMeta](docs/UiNodeMeta.md) - [OryKratosClient::UiNodeScriptAttributes](docs/UiNodeScriptAttributes.md) - [OryKratosClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md) - [OryKratosClient::UiText](docs/UiText.md) - [OryKratosClient::UpdateIdentityBody](docs/UpdateIdentityBody.md) - [OryKratosClient::UpdateLoginFlowBody](docs/UpdateLoginFlowBody.md) - [OryKratosClient::UpdateLoginFlowWithCodeMethod](docs/UpdateLoginFlowWithCodeMethod.md) - [OryKratosClient::UpdateLoginFlowWithLookupSecretMethod](docs/UpdateLoginFlowWithLookupSecretMethod.md) - [OryKratosClient::UpdateLoginFlowWithOidcMethod](docs/UpdateLoginFlowWithOidcMethod.md) - [OryKratosClient::UpdateLoginFlowWithPasswordMethod](docs/UpdateLoginFlowWithPasswordMethod.md) - [OryKratosClient::UpdateLoginFlowWithTotpMethod](docs/UpdateLoginFlowWithTotpMethod.md) - [OryKratosClient::UpdateLoginFlowWithWebAuthnMethod](docs/UpdateLoginFlowWithWebAuthnMethod.md) - [OryKratosClient::UpdateRecoveryFlowBody](docs/UpdateRecoveryFlowBody.md) - [OryKratosClient::UpdateRecoveryFlowWithCodeMethod](docs/UpdateRecoveryFlowWithCodeMethod.md) - [OryKratosClient::UpdateRecoveryFlowWithLinkMethod](docs/UpdateRecoveryFlowWithLinkMethod.md) - [OryKratosClient::UpdateRegistrationFlowBody](docs/UpdateRegistrationFlowBody.md) - [OryKratosClient::UpdateRegistrationFlowWithCodeMethod](docs/UpdateRegistrationFlowWithCodeMethod.md) - [OryKratosClient::UpdateRegistrationFlowWithOidcMethod](docs/UpdateRegistrationFlowWithOidcMethod.md) - [OryKratosClient::UpdateRegistrationFlowWithPasswordMethod](docs/UpdateRegistrationFlowWithPasswordMethod.md) - [OryKratosClient::UpdateRegistrationFlowWithWebAuthnMethod](docs/UpdateRegistrationFlowWithWebAuthnMethod.md) - [OryKratosClient::UpdateSettingsFlowBody](docs/UpdateSettingsFlowBody.md) - [OryKratosClient::UpdateSettingsFlowWithLookupMethod](docs/UpdateSettingsFlowWithLookupMethod.md) - [OryKratosClient::UpdateSettingsFlowWithOidcMethod](docs/UpdateSettingsFlowWithOidcMethod.md) - [OryKratosClient::UpdateSettingsFlowWithPasswordMethod](docs/UpdateSettingsFlowWithPasswordMethod.md) - [OryKratosClient::UpdateSettingsFlowWithProfileMethod](docs/UpdateSettingsFlowWithProfileMethod.md) - [OryKratosClient::UpdateSettingsFlowWithTotpMethod](docs/UpdateSettingsFlowWithTotpMethod.md) - [OryKratosClient::UpdateSettingsFlowWithWebAuthnMethod](docs/UpdateSettingsFlowWithWebAuthnMethod.md) - [OryKratosClient::UpdateVerificationFlowBody](docs/UpdateVerificationFlowBody.md) - [OryKratosClient::UpdateVerificationFlowWithCodeMethod](docs/UpdateVerificationFlowWithCodeMethod.md) - [OryKratosClient::UpdateVerificationFlowWithLinkMethod](docs/UpdateVerificationFlowWithLinkMethod.md) - [OryKratosClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md) - [OryKratosClient::VerificationFlow](docs/VerificationFlow.md) - [OryKratosClient::VerificationFlowState](docs/VerificationFlowState.md) - [OryKratosClient::Version](docs/Version.md) ## Documentation for Authorization ### oryAccessToken - **Type**: API key - **API key parameter name**: Authorization - **Location**: HTTP header