ory-client

OryClient - the Ruby gem for the Ory APIs

Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v0.0.1-alpha.142
  • Package version: v0.0.1-alpha.142
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build ory-client.gemspec

Then either install the gem locally:

gem install ./ory-client-v0.0.1-alpha.142.gem

(for development, run gem install --dev ./ory-client-v0.0.1-alpha.142.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-client', '~> v0.0.1-alpha.142'

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-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-client'

api_instance = OryClient::MetadataApi.new

begin
  #Return Running Software Version.
  result = api_instance.get_version
  p result
rescue OryClient::ApiError => e
  puts "Exception when calling MetadataApi->get_version: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://playground.projects.oryapis.com

Class Method HTTP request Description
OryClient::MetadataApi get_version GET /version Return Running Software Version.
OryClient::MetadataApi is_alive GET /health/alive Check HTTP Server Status
OryClient::MetadataApi is_ready GET /health/ready Check HTTP Server and Database Status
OryClient::V0alpha2Api admin_create_identity POST /admin/identities Create an Identity
OryClient::V0alpha2Api admin_create_self_service_recovery_link POST /admin/recovery/link Create a Recovery Link
OryClient::V0alpha2Api admin_delete_identity DELETE /admin/identities/id Delete an Identity
OryClient::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.
OryClient::V0alpha2Api admin_get_identity GET /admin/identities/id Get an Identity
OryClient::V0alpha2Api admin_list_identities GET /admin/identities List Identities
OryClient::V0alpha2Api admin_list_identity_sessions GET /admin/identities/id/sessions This endpoint returns all sessions that belong to the given Identity.
OryClient::V0alpha2Api admin_update_identity PUT /admin/identities/id Update an Identity
OryClient::V0alpha2Api create_project POST /projects Create a Project
OryClient::V0alpha2Api create_self_service_logout_flow_url_for_browsers GET /self-service/logout/browser Create a Logout URL for Browsers
OryClient::V0alpha2Api get_json_schema GET /schemas/id
OryClient::V0alpha2Api get_project GET /projects/project_id Get a Project
OryClient::V0alpha2Api get_project_members GET /projects/project_id/members Get all members associated with this project.
OryClient::V0alpha2Api get_self_service_error GET /self-service/errors Get Self-Service Errors
OryClient::V0alpha2Api get_self_service_login_flow GET /self-service/login/flows Get Login Flow
OryClient::V0alpha2Api get_self_service_recovery_flow GET /self-service/recovery/flows Get Recovery Flow
OryClient::V0alpha2Api get_self_service_registration_flow GET /self-service/registration/flows Get Registration Flow
OryClient::V0alpha2Api get_self_service_settings_flow GET /self-service/settings/flows Get Settings Flow
OryClient::V0alpha2Api get_self_service_verification_flow GET /self-service/verification/flows Get Verification Flow
OryClient::V0alpha2Api get_web_authn_java_script GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
OryClient::V0alpha2Api initialize_self_service_login_flow_for_browsers GET /self-service/login/browser Initialize Login Flow for Browsers
OryClient::V0alpha2Api initialize_self_service_login_flow_without_browser GET /self-service/login/api Initialize Login Flow for APIs, Services, Apps, ...
OryClient::V0alpha2Api initialize_self_service_recovery_flow_for_browsers GET /self-service/recovery/browser Initialize Recovery Flow for Browsers
OryClient::V0alpha2Api initialize_self_service_recovery_flow_without_browser GET /self-service/recovery/api Initialize Recovery Flow for APIs, Services, Apps, ...
OryClient::V0alpha2Api initialize_self_service_registration_flow_for_browsers GET /self-service/registration/browser Initialize Registration Flow for Browsers
OryClient::V0alpha2Api initialize_self_service_registration_flow_without_browser GET /self-service/registration/api Initialize Registration Flow for APIs, Services, Apps, ...
OryClient::V0alpha2Api initialize_self_service_settings_flow_for_browsers GET /self-service/settings/browser Initialize Settings Flow for Browsers
OryClient::V0alpha2Api initialize_self_service_settings_flow_without_browser GET /self-service/settings/api Initialize Settings Flow for APIs, Services, Apps, ...
OryClient::V0alpha2Api initialize_self_service_verification_flow_for_browsers GET /self-service/verification/browser Initialize Verification Flow for Browser Clients
OryClient::V0alpha2Api initialize_self_service_verification_flow_without_browser GET /self-service/verification/api Initialize Verification Flow for APIs, Services, Apps, ...
OryClient::V0alpha2Api list_identity_schemas GET /schemas
OryClient::V0alpha2Api list_projects GET /projects List All Projects
OryClient::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.
OryClient::V0alpha2Api patch_project PATCH /projects/project_id Patch an Ory Cloud Project Configuration
OryClient::V0alpha2Api purge_project DELETE /projects/project_id Irrecoverably Purge a Project
OryClient::V0alpha2Api remove_project_member DELETE /projects/project_id/members/member_id Remove a member associated with this project. This also sets their invite status to REMOVED.
OryClient::V0alpha2Api revoke_session DELETE /sessions/id Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
OryClient::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.
OryClient::V0alpha2Api submit_self_service_login_flow POST /self-service/login Submit a Login Flow
OryClient::V0alpha2Api submit_self_service_logout_flow GET /self-service/logout Complete Self-Service Logout
OryClient::V0alpha2Api submit_self_service_logout_flow_without_browser DELETE /self-service/logout/api Perform Logout for APIs, Services, Apps, ...
OryClient::V0alpha2Api submit_self_service_recovery_flow POST /self-service/recovery Complete Recovery Flow
OryClient::V0alpha2Api submit_self_service_registration_flow POST /self-service/registration Submit a Registration Flow
OryClient::V0alpha2Api submit_self_service_settings_flow POST /self-service/settings Complete Settings Flow
OryClient::V0alpha2Api submit_self_service_verification_flow POST /self-service/verification Complete Verification Flow
OryClient::V0alpha2Api to_session GET /sessions/whoami Check Who the Current HTTP Session Belongs To
OryClient::V0alpha2Api update_project PUT /projects/project_id Update an Ory Cloud Project Configuration

Documentation for Models

Documentation for Authorization

oryAccessToken

  • Type: Bearer authentication