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: v0.11.0
  • Package version: v0.11.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-v0.11.0.gem

(for development, run gem install --dev ./ory-kratos-client-v0.11.0.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', '~> v0.11.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:

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
opts = {
  per_page: 789, # Integer | Items per Page  This is the number of items per page.
  page: 789, # Integer | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
  status: OryKratosClient::CourierMessageStatus::QUEUED, # CourierMessageStatus | Status filters out messages based on status. If no value is provided, it doesn't take effect on filter.
  recipient: 'recipient_example' # String | Recipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.
}

begin
  #List Messages
  result = api_instance.list_courier_messages(opts)
  p result
rescue OryKratosClient::ApiError => e
  puts "Exception when calling CourierApi->list_courier_messages: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
OryKratosClient::CourierApi list_courier_messages GET /admin/courier/messages List Messages
OryKratosClient::FrontendApi create_browser_login_flow GET /self-service/login/browser Create Login Flow for Browsers
OryKratosClient::FrontendApi create_browser_logout_flow GET /self-service/logout/browser Create a Logout URL for Browsers
OryKratosClient::FrontendApi create_browser_recovery_flow GET /self-service/recovery/browser Create Recovery Flow for Browsers
OryKratosClient::FrontendApi create_browser_registration_flow GET /self-service/registration/browser Create Registration Flow for Browsers
OryKratosClient::FrontendApi create_browser_settings_flow GET /self-service/settings/browser Create Settings Flow for Browsers
OryKratosClient::FrontendApi create_browser_verification_flow GET /self-service/verification/browser Create Verification Flow for Browser Clients
OryKratosClient::FrontendApi create_native_login_flow GET /self-service/login/api Create Login Flow for Native Apps
OryKratosClient::FrontendApi create_native_recovery_flow GET /self-service/recovery/api Create Recovery Flow for Native Apps
OryKratosClient::FrontendApi create_native_registration_flow GET /self-service/registration/api Create Registration Flow for Native Apps
OryKratosClient::FrontendApi create_native_settings_flow GET /self-service/settings/api Create Settings Flow for Native Apps
OryKratosClient::FrontendApi create_native_verification_flow GET /self-service/verification/api Create Verification Flow for Native Apps
OryKratosClient::FrontendApi disable_my_other_sessions DELETE /sessions Disable my other sessions
OryKratosClient::FrontendApi disable_my_session DELETE /sessions/id Disable one of my sessions
OryKratosClient::FrontendApi get_flow_error GET /self-service/errors Get User-Flow Errors
OryKratosClient::FrontendApi get_login_flow GET /self-service/login/flows Get Login Flow
OryKratosClient::FrontendApi get_recovery_flow GET /self-service/recovery/flows Get Recovery Flow
OryKratosClient::FrontendApi get_registration_flow GET /self-service/registration/flows Get Registration Flow
OryKratosClient::FrontendApi get_settings_flow GET /self-service/settings/flows Get Settings Flow
OryKratosClient::FrontendApi get_verification_flow GET /self-service/verification/flows Get Verification Flow
OryKratosClient::FrontendApi get_web_authn_java_script GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
OryKratosClient::FrontendApi list_my_sessions GET /sessions Get My Active Sessions
OryKratosClient::FrontendApi perform_native_logout DELETE /self-service/logout/api Perform Logout for Native Apps
OryKratosClient::FrontendApi to_session GET /sessions/whoami Check Who the Current HTTP Session Belongs To
OryKratosClient::FrontendApi update_login_flow POST /self-service/login Submit a Login Flow
OryKratosClient::FrontendApi update_logout_flow GET /self-service/logout Update Logout Flow
OryKratosClient::FrontendApi update_recovery_flow POST /self-service/recovery Complete Recovery Flow
OryKratosClient::FrontendApi update_registration_flow POST /self-service/registration Update Registration Flow
OryKratosClient::FrontendApi update_settings_flow POST /self-service/settings Complete Settings Flow
OryKratosClient::FrontendApi update_verification_flow POST /self-service/verification Complete Verification Flow
OryKratosClient::IdentityApi create_identity POST /admin/identities Create an Identity
OryKratosClient::IdentityApi create_recovery_code_for_identity POST /admin/recovery/code Create a Recovery Code
OryKratosClient::IdentityApi create_recovery_link_for_identity POST /admin/recovery/link Create a Recovery Link
OryKratosClient::IdentityApi delete_identity DELETE /admin/identities/id Delete an Identity
OryKratosClient::IdentityApi delete_identity_sessions DELETE /admin/identities/id/sessions Delete & Invalidate an Identity's Sessions
OryKratosClient::IdentityApi disable_session DELETE /admin/sessions/id Deactivate a Session
OryKratosClient::IdentityApi extend_session PATCH /admin/sessions/id/extend Extend a Session
OryKratosClient::IdentityApi get_identity GET /admin/identities/id Get an Identity
OryKratosClient::IdentityApi get_identity_schema GET /schemas/id Get Identity JSON Schema
OryKratosClient::IdentityApi get_session GET /admin/sessions/id This endpoint returns the session object with expandables specified.
OryKratosClient::IdentityApi list_identities GET /admin/identities List Identities
OryKratosClient::IdentityApi list_identity_schemas GET /schemas Get all Identity Schemas
OryKratosClient::IdentityApi list_identity_sessions GET /admin/identities/id/sessions List an Identity's Sessions
OryKratosClient::IdentityApi list_sessions GET /admin/sessions List All Sessions
OryKratosClient::IdentityApi patch_identity PATCH /admin/identities/id Patch an Identity
OryKratosClient::IdentityApi update_identity PUT /admin/identities/id Update an Identity
OryKratosClient::MetadataApi get_version GET /version Return Running Software Version.
OryKratosClient::MetadataApi is_alive GET /health/alive Check HTTP Server Status
OryKratosClient::MetadataApi is_ready GET /health/ready Check HTTP Server and Database Status

Documentation for Models

Documentation for Authorization

oryAccessToken

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