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

  • API version: v0.10.1
  • Package version: v0.10.1
  • 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.10.1.gem

(for development, run gem install --dev ./ory-kratos-client-v0.10.1.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.10.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:

ruby -Ilib script.rb

Getting Started

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

# 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 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
OryKratosClient::V0alpha2Api admin_create_identity POST /admin/identities Create an Identity
OryKratosClient::V0alpha2Api admin_create_self_service_recovery_link POST /admin/recovery/link Create a Recovery Link
OryKratosClient::V0alpha2Api admin_delete_identity DELETE /admin/identities/id Delete an Identity
OryKratosClient::V0alpha2Api admin_delete_identity_sessions DELETE /admin/identities/id/sessions Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
OryKratosClient::V0alpha2Api admin_extend_session PATCH /admin/sessions/id/extend Calling this endpoint extends the given session ID. If session.earliest_possible_extend is set it will only extend the session after the specified time has passed.
OryKratosClient::V0alpha2Api admin_get_identity GET /admin/identities/id Get an Identity
OryKratosClient::V0alpha2Api admin_list_identities GET /admin/identities List Identities
OryKratosClient::V0alpha2Api admin_list_identity_sessions GET /admin/identities/id/sessions This endpoint returns all sessions that belong to the given Identity.
OryKratosClient::V0alpha2Api admin_update_identity PUT /admin/identities/id Update an Identity
OryKratosClient::V0alpha2Api create_self_service_logout_flow_url_for_browsers GET /self-service/logout/browser Create a Logout URL for Browsers
OryKratosClient::V0alpha2Api get_json_schema GET /schemas/id
OryKratosClient::V0alpha2Api get_self_service_error GET /self-service/errors Get Self-Service Errors
OryKratosClient::V0alpha2Api get_self_service_login_flow GET /self-service/login/flows Get Login Flow
OryKratosClient::V0alpha2Api get_self_service_recovery_flow GET /self-service/recovery/flows Get Recovery Flow
OryKratosClient::V0alpha2Api get_self_service_registration_flow GET /self-service/registration/flows Get Registration Flow
OryKratosClient::V0alpha2Api get_self_service_settings_flow GET /self-service/settings/flows Get Settings Flow
OryKratosClient::V0alpha2Api get_self_service_verification_flow GET /self-service/verification/flows Get Verification Flow
OryKratosClient::V0alpha2Api get_web_authn_java_script GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
OryKratosClient::V0alpha2Api initialize_self_service_login_flow_for_browsers GET /self-service/login/browser Initialize Login Flow for Browsers
OryKratosClient::V0alpha2Api initialize_self_service_login_flow_without_browser GET /self-service/login/api Initialize Login Flow for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api initialize_self_service_recovery_flow_for_browsers GET /self-service/recovery/browser Initialize Recovery Flow for Browsers
OryKratosClient::V0alpha2Api initialize_self_service_recovery_flow_without_browser GET /self-service/recovery/api Initialize Recovery Flow for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api initialize_self_service_registration_flow_for_browsers GET /self-service/registration/browser Initialize Registration Flow for Browsers
OryKratosClient::V0alpha2Api initialize_self_service_registration_flow_without_browser GET /self-service/registration/api Initialize Registration Flow for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api initialize_self_service_settings_flow_for_browsers GET /self-service/settings/browser Initialize Settings Flow for Browsers
OryKratosClient::V0alpha2Api initialize_self_service_settings_flow_without_browser GET /self-service/settings/api Initialize Settings Flow for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api initialize_self_service_verification_flow_for_browsers GET /self-service/verification/browser Initialize Verification Flow for Browser Clients
OryKratosClient::V0alpha2Api initialize_self_service_verification_flow_without_browser GET /self-service/verification/api Initialize Verification Flow for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api list_identity_schemas GET /schemas
OryKratosClient::V0alpha2Api list_sessions GET /sessions This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the /sessions/whoami endpoint.
OryKratosClient::V0alpha2Api revoke_session DELETE /sessions/id Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
OryKratosClient::V0alpha2Api revoke_sessions DELETE /sessions Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
OryKratosClient::V0alpha2Api submit_self_service_login_flow POST /self-service/login Submit a Login Flow
OryKratosClient::V0alpha2Api submit_self_service_logout_flow GET /self-service/logout Complete Self-Service Logout
OryKratosClient::V0alpha2Api submit_self_service_logout_flow_without_browser DELETE /self-service/logout/api Perform Logout for APIs, Services, Apps, ...
OryKratosClient::V0alpha2Api submit_self_service_recovery_flow POST /self-service/recovery Complete Recovery Flow
OryKratosClient::V0alpha2Api submit_self_service_registration_flow POST /self-service/registration Submit a Registration Flow
OryKratosClient::V0alpha2Api submit_self_service_settings_flow POST /self-service/settings Complete Settings Flow
OryKratosClient::V0alpha2Api submit_self_service_verification_flow POST /self-service/verification Complete Verification Flow
OryKratosClient::V0alpha2Api to_session GET /sessions/whoami Check Who the Current HTTP Session Belongs To

Documentation for Models

Documentation for Authorization

oryAccessToken

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