🚀 DAY 5 OF LAUNCH WEEK: Introducing Socket Firewall Enterprise.Learn more →
Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

ory-kratos-client

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ory-kratos-client

bundlerRubygems
Version
1.3.8
Version published
Maintainers
1
Created
Source

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 project:

  • API version: v1.3.8
  • Package version: v1.3.8
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build ory-kratos-client.gemspec

Then either install the gem locally:

gem install ./ory-kratos-client-v1.3.8.gem

(for development, run gem install --dev ./ory-kratos-client-v1.3.8.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'ory-kratos-client', '~> v1.3.8'

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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# 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

ClassMethodHTTP requestDescription
OryKratosClient::CourierApiget_courier_messageGET /admin/courier/messages/{id}Get a Message
OryKratosClient::CourierApilist_courier_messagesGET /admin/courier/messagesList Messages
OryKratosClient::FrontendApicreate_browser_login_flowGET /self-service/login/browserCreate Login Flow for Browsers
OryKratosClient::FrontendApicreate_browser_logout_flowGET /self-service/logout/browserCreate a Logout URL for Browsers
OryKratosClient::FrontendApicreate_browser_recovery_flowGET /self-service/recovery/browserCreate Recovery Flow for Browsers
OryKratosClient::FrontendApicreate_browser_registration_flowGET /self-service/registration/browserCreate Registration Flow for Browsers
OryKratosClient::FrontendApicreate_browser_settings_flowGET /self-service/settings/browserCreate Settings Flow for Browsers
OryKratosClient::FrontendApicreate_browser_verification_flowGET /self-service/verification/browserCreate Verification Flow for Browser Clients
OryKratosClient::FrontendApicreate_fedcm_flowGET /self-service/fed-cm/parametersGet FedCM Parameters
OryKratosClient::FrontendApicreate_native_login_flowGET /self-service/login/apiCreate Login Flow for Native Apps
OryKratosClient::FrontendApicreate_native_recovery_flowGET /self-service/recovery/apiCreate Recovery Flow for Native Apps
OryKratosClient::FrontendApicreate_native_registration_flowGET /self-service/registration/apiCreate Registration Flow for Native Apps
OryKratosClient::FrontendApicreate_native_settings_flowGET /self-service/settings/apiCreate Settings Flow for Native Apps
OryKratosClient::FrontendApicreate_native_verification_flowGET /self-service/verification/apiCreate Verification Flow for Native Apps
OryKratosClient::FrontendApidisable_my_other_sessionsDELETE /sessionsDisable my other sessions
OryKratosClient::FrontendApidisable_my_sessionDELETE /sessions/{id}Disable one of my sessions
OryKratosClient::FrontendApiexchange_session_tokenGET /sessions/token-exchangeExchange Session Token
OryKratosClient::FrontendApiget_flow_errorGET /self-service/errorsGet User-Flow Errors
OryKratosClient::FrontendApiget_login_flowGET /self-service/login/flowsGet Login Flow
OryKratosClient::FrontendApiget_recovery_flowGET /self-service/recovery/flowsGet Recovery Flow
OryKratosClient::FrontendApiget_registration_flowGET /self-service/registration/flowsGet Registration Flow
OryKratosClient::FrontendApiget_settings_flowGET /self-service/settings/flowsGet Settings Flow
OryKratosClient::FrontendApiget_verification_flowGET /self-service/verification/flowsGet Verification Flow
OryKratosClient::FrontendApiget_web_authn_java_scriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
OryKratosClient::FrontendApilist_my_sessionsGET /sessionsGet My Active Sessions
OryKratosClient::FrontendApiperform_native_logoutDELETE /self-service/logout/apiPerform Logout for Native Apps
OryKratosClient::FrontendApito_sessionGET /sessions/whoamiCheck Who the Current HTTP Session Belongs To
OryKratosClient::FrontendApiupdate_fedcm_flowPOST /self-service/fed-cm/tokenSubmit a FedCM token
OryKratosClient::FrontendApiupdate_login_flowPOST /self-service/loginSubmit a Login Flow
OryKratosClient::FrontendApiupdate_logout_flowGET /self-service/logoutUpdate Logout Flow
OryKratosClient::FrontendApiupdate_recovery_flowPOST /self-service/recoveryUpdate Recovery Flow
OryKratosClient::FrontendApiupdate_registration_flowPOST /self-service/registrationUpdate Registration Flow
OryKratosClient::FrontendApiupdate_settings_flowPOST /self-service/settingsComplete Settings Flow
OryKratosClient::FrontendApiupdate_verification_flowPOST /self-service/verificationComplete Verification Flow
OryKratosClient::IdentityApibatch_patch_identitiesPATCH /admin/identitiesCreate multiple identities
OryKratosClient::IdentityApicreate_identityPOST /admin/identitiesCreate an Identity
OryKratosClient::IdentityApicreate_recovery_code_for_identityPOST /admin/recovery/codeCreate a Recovery Code
OryKratosClient::IdentityApicreate_recovery_link_for_identityPOST /admin/recovery/linkCreate a Recovery Link
OryKratosClient::IdentityApidelete_identityDELETE /admin/identities/{id}Delete an Identity
OryKratosClient::IdentityApidelete_identity_credentialsDELETE /admin/identities/{id}/credentials/{type}Delete a credential for a specific identity
OryKratosClient::IdentityApidelete_identity_sessionsDELETE /admin/identities/{id}/sessionsDelete & Invalidate an Identity's Sessions
OryKratosClient::IdentityApidisable_sessionDELETE /admin/sessions/{id}Deactivate a Session
OryKratosClient::IdentityApiextend_sessionPATCH /admin/sessions/{id}/extendExtend a Session
OryKratosClient::IdentityApiget_identityGET /admin/identities/{id}Get an Identity
OryKratosClient::IdentityApiget_identity_schemaGET /schemas/{id}Get Identity JSON Schema
OryKratosClient::IdentityApiget_sessionGET /admin/sessions/{id}Get Session
OryKratosClient::IdentityApilist_identitiesGET /admin/identitiesList Identities
OryKratosClient::IdentityApilist_identity_schemasGET /schemasGet all Identity Schemas
OryKratosClient::IdentityApilist_identity_sessionsGET /admin/identities/{id}/sessionsList an Identity's Sessions
OryKratosClient::IdentityApilist_sessionsGET /admin/sessionsList All Sessions
OryKratosClient::IdentityApipatch_identityPATCH /admin/identities/{id}Patch an Identity
OryKratosClient::IdentityApiupdate_identityPUT /admin/identities/{id}Update an Identity
OryKratosClient::MetadataApiget_versionGET /versionReturn Running Software Version.
OryKratosClient::MetadataApiis_aliveGET /health/aliveCheck HTTP Server Status
OryKratosClient::MetadataApiis_readyGET /health/readyCheck HTTP Server and Database Status

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

oryAccessToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

FAQs

Package last updated on 25 Feb 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

The Changelog Podcast: Practical Steps to Stay Safe on npm

Security News

The Changelog Podcast: Practical Steps to Stay Safe on npm

Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.

By Sarah Gooding  -  Oct 31, 2025