New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

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

  • 1.16.6
  • Rubygems
  • Socket score
Version published
Maintainers
1
Created
Source

ory-client

OryClient - the Ruby gem for the Ory APIs

Introduction

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.

SDKs

This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages:

LanguageDownload SDKDocumentation
Dartpub.devREADME
.NETnuget.orgREADME
Elixirhex.pmREADME
Gogithub.comREADME
Javamaven.orgREADME
JavaScriptnpmjs.comREADME
JavaScript (With fetch)npmjs.comREADME
PHPpackagist.orgREADME
Pythonpypi.orgREADME
Rubyrubygems.orgREADME
Rustcrates.ioREADME

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1.16.6
  • Package version: v1.16.6
  • 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-client.gemspec

Then either install the gem locally:

gem install ./ory-client-v1.16.6.gem

(for development, run gem install --dev ./ory-client-v1.16.6.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', '~> v1.16.6'

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'

# Setup authorization
OryClient.configure do |config|
  # Configure Bearer authorization: oryAccessToken
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = OryClient::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 OryClient::ApiError => e
  puts "Exception when calling CourierApi->get_courier_message: #{e}"
end

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
OryClient::CourierApiget_courier_messageGET /admin/courier/messages/{id}Get a Message
OryClient::CourierApilist_courier_messagesGET /admin/courier/messagesList Messages
OryClient::EventsApicreate_event_streamPOST /projects/{project_id}/eventstreamsCreate an event stream for your project.
OryClient::EventsApidelete_event_streamDELETE /projects/{project_id}/eventstreams/{event_stream_id}Remove an event stream from a project
OryClient::EventsApilist_event_streamsGET /projects/{project_id}/eventstreamsList all event streams for the project. This endpoint is not paginated.
OryClient::EventsApiset_event_streamPUT /projects/{project_id}/eventstreams/{event_stream_id}Update an event stream for a project.
OryClient::FrontendApicreate_browser_login_flowGET /self-service/login/browserCreate Login Flow for Browsers
OryClient::FrontendApicreate_browser_logout_flowGET /self-service/logout/browserCreate a Logout URL for Browsers
OryClient::FrontendApicreate_browser_recovery_flowGET /self-service/recovery/browserCreate Recovery Flow for Browsers
OryClient::FrontendApicreate_browser_registration_flowGET /self-service/registration/browserCreate Registration Flow for Browsers
OryClient::FrontendApicreate_browser_settings_flowGET /self-service/settings/browserCreate Settings Flow for Browsers
OryClient::FrontendApicreate_browser_verification_flowGET /self-service/verification/browserCreate Verification Flow for Browser Clients
OryClient::FrontendApicreate_fedcm_flowGET /self-service/fed-cm/parametersGet FedCM Parameters
OryClient::FrontendApicreate_native_login_flowGET /self-service/login/apiCreate Login Flow for Native Apps
OryClient::FrontendApicreate_native_recovery_flowGET /self-service/recovery/apiCreate Recovery Flow for Native Apps
OryClient::FrontendApicreate_native_registration_flowGET /self-service/registration/apiCreate Registration Flow for Native Apps
OryClient::FrontendApicreate_native_settings_flowGET /self-service/settings/apiCreate Settings Flow for Native Apps
OryClient::FrontendApicreate_native_verification_flowGET /self-service/verification/apiCreate Verification Flow for Native Apps
OryClient::FrontendApidisable_my_other_sessionsDELETE /sessionsDisable my other sessions
OryClient::FrontendApidisable_my_sessionDELETE /sessions/{id}Disable one of my sessions
OryClient::FrontendApiexchange_session_tokenGET /sessions/token-exchangeExchange Session Token
OryClient::FrontendApiget_flow_errorGET /self-service/errorsGet User-Flow Errors
OryClient::FrontendApiget_login_flowGET /self-service/login/flowsGet Login Flow
OryClient::FrontendApiget_recovery_flowGET /self-service/recovery/flowsGet Recovery Flow
OryClient::FrontendApiget_registration_flowGET /self-service/registration/flowsGet Registration Flow
OryClient::FrontendApiget_settings_flowGET /self-service/settings/flowsGet Settings Flow
OryClient::FrontendApiget_verification_flowGET /self-service/verification/flowsGet Verification Flow
OryClient::FrontendApiget_web_authn_java_scriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
OryClient::FrontendApilist_my_sessionsGET /sessionsGet My Active Sessions
OryClient::FrontendApiperform_native_logoutDELETE /self-service/logout/apiPerform Logout for Native Apps
OryClient::FrontendApito_sessionGET /sessions/whoamiCheck Who the Current HTTP Session Belongs To
OryClient::FrontendApiupdate_fedcm_flowPOST /self-service/fed-cm/tokenSubmit a FedCM token
OryClient::FrontendApiupdate_login_flowPOST /self-service/loginSubmit a Login Flow
OryClient::FrontendApiupdate_logout_flowGET /self-service/logoutUpdate Logout Flow
OryClient::FrontendApiupdate_recovery_flowPOST /self-service/recoveryUpdate Recovery Flow
OryClient::FrontendApiupdate_registration_flowPOST /self-service/registrationUpdate Registration Flow
OryClient::FrontendApiupdate_settings_flowPOST /self-service/settingsComplete Settings Flow
OryClient::FrontendApiupdate_verification_flowPOST /self-service/verificationComplete Verification Flow
OryClient::IdentityApibatch_patch_identitiesPATCH /admin/identitiesCreate multiple identities
OryClient::IdentityApicreate_identityPOST /admin/identitiesCreate an Identity
OryClient::IdentityApicreate_recovery_code_for_identityPOST /admin/recovery/codeCreate a Recovery Code
OryClient::IdentityApicreate_recovery_link_for_identityPOST /admin/recovery/linkCreate a Recovery Link
OryClient::IdentityApidelete_identityDELETE /admin/identities/{id}Delete an Identity
OryClient::IdentityApidelete_identity_credentialsDELETE /admin/identities/{id}/credentials/{type}Delete a credential for a specific identity
OryClient::IdentityApidelete_identity_sessionsDELETE /admin/identities/{id}/sessionsDelete & Invalidate an Identity's Sessions
OryClient::IdentityApidisable_sessionDELETE /admin/sessions/{id}Deactivate a Session
OryClient::IdentityApiextend_sessionPATCH /admin/sessions/{id}/extendExtend a Session
OryClient::IdentityApiget_identityGET /admin/identities/{id}Get an Identity
OryClient::IdentityApiget_identity_schemaGET /schemas/{id}Get Identity JSON Schema
OryClient::IdentityApiget_sessionGET /admin/sessions/{id}Get Session
OryClient::IdentityApilist_identitiesGET /admin/identitiesList Identities
OryClient::IdentityApilist_identity_schemasGET /schemasGet all Identity Schemas
OryClient::IdentityApilist_identity_sessionsGET /admin/identities/{id}/sessionsList an Identity's Sessions
OryClient::IdentityApilist_sessionsGET /admin/sessionsList All Sessions
OryClient::IdentityApipatch_identityPATCH /admin/identities/{id}Patch an Identity
OryClient::IdentityApiupdate_identityPUT /admin/identities/{id}Update an Identity
OryClient::JwkApicreate_json_web_key_setPOST /admin/keys/{set}Create JSON Web Key
OryClient::JwkApidelete_json_web_keyDELETE /admin/keys/{set}/{kid}Delete JSON Web Key
OryClient::JwkApidelete_json_web_key_setDELETE /admin/keys/{set}Delete JSON Web Key Set
OryClient::JwkApiget_json_web_keyGET /admin/keys/{set}/{kid}Get JSON Web Key
OryClient::JwkApiget_json_web_key_setGET /admin/keys/{set}Retrieve a JSON Web Key Set
OryClient::JwkApiset_json_web_keyPUT /admin/keys/{set}/{kid}Set JSON Web Key
OryClient::JwkApiset_json_web_key_setPUT /admin/keys/{set}Update a JSON Web Key Set
OryClient::MetadataApiget_versionGET /versionReturn Running Software Version.
OryClient::OAuth2Apiaccept_o_auth2_consent_requestPUT /admin/oauth2/auth/requests/consent/acceptAccept OAuth 2.0 Consent Request
OryClient::OAuth2Apiaccept_o_auth2_login_requestPUT /admin/oauth2/auth/requests/login/acceptAccept OAuth 2.0 Login Request
OryClient::OAuth2Apiaccept_o_auth2_logout_requestPUT /admin/oauth2/auth/requests/logout/acceptAccept OAuth 2.0 Session Logout Request
OryClient::OAuth2Apicreate_o_auth2_clientPOST /admin/clientsCreate OAuth 2.0 Client
OryClient::OAuth2Apidelete_o_auth2_clientDELETE /admin/clients/{id}Delete OAuth 2.0 Client
OryClient::OAuth2Apidelete_o_auth2_tokenDELETE /admin/oauth2/tokensDelete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
OryClient::OAuth2Apidelete_trusted_o_auth2_jwt_grant_issuerDELETE /admin/trust/grants/jwt-bearer/issuers/{id}Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
OryClient::OAuth2Apiget_o_auth2_clientGET /admin/clients/{id}Get an OAuth 2.0 Client
OryClient::OAuth2Apiget_o_auth2_consent_requestGET /admin/oauth2/auth/requests/consentGet OAuth 2.0 Consent Request
OryClient::OAuth2Apiget_o_auth2_login_requestGET /admin/oauth2/auth/requests/loginGet OAuth 2.0 Login Request
OryClient::OAuth2Apiget_o_auth2_logout_requestGET /admin/oauth2/auth/requests/logoutGet OAuth 2.0 Session Logout Request
OryClient::OAuth2Apiget_trusted_o_auth2_jwt_grant_issuerGET /admin/trust/grants/jwt-bearer/issuers/{id}Get Trusted OAuth2 JWT Bearer Grant Type Issuer
OryClient::OAuth2Apiintrospect_o_auth2_tokenPOST /admin/oauth2/introspectIntrospect OAuth2 Access and Refresh Tokens
OryClient::OAuth2Apilist_o_auth2_clientsGET /admin/clientsList OAuth 2.0 Clients
OryClient::OAuth2Apilist_o_auth2_consent_sessionsGET /admin/oauth2/auth/sessions/consentList OAuth 2.0 Consent Sessions of a Subject
OryClient::OAuth2Apilist_trusted_o_auth2_jwt_grant_issuersGET /admin/trust/grants/jwt-bearer/issuersList Trusted OAuth2 JWT Bearer Grant Type Issuers
OryClient::OAuth2Apio_auth2_authorizeGET /oauth2/authOAuth 2.0 Authorize Endpoint
OryClient::OAuth2Apioauth2_token_exchangePOST /oauth2/tokenThe OAuth 2.0 Token Endpoint
OryClient::OAuth2Apipatch_o_auth2_clientPATCH /admin/clients/{id}Patch OAuth 2.0 Client
OryClient::OAuth2Apireject_o_auth2_consent_requestPUT /admin/oauth2/auth/requests/consent/rejectReject OAuth 2.0 Consent Request
OryClient::OAuth2Apireject_o_auth2_login_requestPUT /admin/oauth2/auth/requests/login/rejectReject OAuth 2.0 Login Request
OryClient::OAuth2Apireject_o_auth2_logout_requestPUT /admin/oauth2/auth/requests/logout/rejectReject OAuth 2.0 Session Logout Request
OryClient::OAuth2Apirevoke_o_auth2_consent_sessionsDELETE /admin/oauth2/auth/sessions/consentRevoke OAuth 2.0 Consent Sessions of a Subject
OryClient::OAuth2Apirevoke_o_auth2_login_sessionsDELETE /admin/oauth2/auth/sessions/loginRevokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
OryClient::OAuth2Apirevoke_o_auth2_tokenPOST /oauth2/revokeRevoke OAuth 2.0 Access or Refresh Token
OryClient::OAuth2Apiset_o_auth2_clientPUT /admin/clients/{id}Set OAuth 2.0 Client
OryClient::OAuth2Apiset_o_auth2_client_lifespansPUT /admin/clients/{id}/lifespansSet OAuth2 Client Token Lifespans
OryClient::OAuth2Apitrust_o_auth2_jwt_grant_issuerPOST /admin/trust/grants/jwt-bearer/issuersTrust OAuth2 JWT Bearer Grant Type Issuer
OryClient::OidcApicreate_oidc_dynamic_clientPOST /oauth2/registerRegister OAuth2 Client using OpenID Dynamic Client Registration
OryClient::OidcApicreate_verifiable_credentialPOST /credentialsIssues a Verifiable Credential
OryClient::OidcApidelete_oidc_dynamic_clientDELETE /oauth2/register/{id}Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
OryClient::OidcApidiscover_oidc_configurationGET /.well-known/openid-configurationOpenID Connect Discovery
OryClient::OidcApiget_oidc_dynamic_clientGET /oauth2/register/{id}Get OAuth2 Client using OpenID Dynamic Client Registration
OryClient::OidcApiget_oidc_user_infoGET /userinfoOpenID Connect Userinfo
OryClient::OidcApirevoke_oidc_sessionGET /oauth2/sessions/logoutOpenID Connect Front- and Back-channel Enabled Logout
OryClient::OidcApiset_oidc_dynamic_clientPUT /oauth2/register/{id}Set OAuth2 Client using OpenID Dynamic Client Registration
OryClient::PermissionApibatch_check_permissionPOST /relation-tuples/batch/checkBatch check permissions
OryClient::PermissionApicheck_permissionGET /relation-tuples/check/openapiCheck a permission
OryClient::PermissionApicheck_permission_or_errorGET /relation-tuples/checkCheck a permission
OryClient::PermissionApiexpand_permissionsGET /relation-tuples/expandExpand a Relationship into permissions.
OryClient::PermissionApipost_check_permissionPOST /relation-tuples/check/openapiCheck a permission
OryClient::PermissionApipost_check_permission_or_errorPOST /relation-tuples/checkCheck a permission
OryClient::ProjectApicreate_organizationPOST /projects/{project_id}/organizationsCreate an Enterprise SSO Organization
OryClient::ProjectApicreate_projectPOST /projectsCreate a Project
OryClient::ProjectApicreate_project_api_keyPOST /projects/{project}/tokensCreate project API key
OryClient::ProjectApidelete_organizationDELETE /projects/{project_id}/organizations/{organization_id}Delete Enterprise SSO Organization
OryClient::ProjectApidelete_project_api_keyDELETE /projects/{project}/tokens/{token_id}Delete project API key
OryClient::ProjectApiget_organizationGET /projects/{project_id}/organizations/{organization_id}Get Enterprise SSO Organization by ID
OryClient::ProjectApiget_projectGET /projects/{project_id}Get a Project
OryClient::ProjectApiget_project_membersGET /projects/{project}/membersGet all members associated with this project
OryClient::ProjectApilist_organizationsGET /projects/{project_id}/organizationsList all Enterprise SSO organizations
OryClient::ProjectApilist_project_api_keysGET /projects/{project}/tokensList a project's API keys
OryClient::ProjectApilist_projectsGET /projectsList All Projects
OryClient::ProjectApipatch_projectPATCH /projects/{project_id}Patch an Ory Network Project Configuration
OryClient::ProjectApipatch_project_with_revisionPATCH /projects/{project_id}/revision/{revision_id}Patch an Ory Network Project Configuration based on a revision ID
OryClient::ProjectApipurge_projectDELETE /projects/{project_id}Irrecoverably purge a project
OryClient::ProjectApiremove_project_memberDELETE /projects/{project}/members/{member}Remove a member associated with this project
OryClient::ProjectApiset_projectPUT /projects/{project_id}Update an Ory Network Project Configuration
OryClient::ProjectApiupdate_organizationPUT /projects/{project_id}/organizations/{organization_id}Update an Enterprise SSO Organization
OryClient::RelationshipApicheck_opl_syntaxPOST /opl/syntax/checkCheck the syntax of an OPL file
OryClient::RelationshipApicreate_relationshipPUT /admin/relation-tuplesCreate a Relationship
OryClient::RelationshipApidelete_relationshipsDELETE /admin/relation-tuplesDelete Relationships
OryClient::RelationshipApiget_relationshipsGET /relation-tuplesQuery relationships
OryClient::RelationshipApilist_relationship_namespacesGET /namespacesQuery namespaces
OryClient::RelationshipApipatch_relationshipsPATCH /admin/relation-tuplesPatch Multiple Relationships
OryClient::WellknownApidiscover_json_web_keysGET /.well-known/jwks.jsonDiscover Well-Known JSON Web Keys
OryClient::WorkspaceApicreate_workspacePOST /workspacesCreate a new workspace
OryClient::WorkspaceApicreate_workspace_api_keyPOST /workspaces/{workspace}/tokensCreate workspace API key
OryClient::WorkspaceApidelete_workspace_api_keyDELETE /workspaces/{workspace}/tokens/{token_id}Delete workspace API key
OryClient::WorkspaceApiget_workspaceGET /workspaces/{workspace}Get a workspace
OryClient::WorkspaceApilist_workspace_api_keysGET /workspaces/{workspace}/tokensList a workspace's API keys
OryClient::WorkspaceApilist_workspace_projectsGET /workspaces/{workspace}/projectsList all projects of a workspace
OryClient::WorkspaceApilist_workspacesGET /workspacesList workspaces the user is a member of
OryClient::WorkspaceApiupdate_workspacePUT /workspaces/{workspace}Update an workspace

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basic

  • Type: HTTP basic authentication

bearer

  • Type: Bearer authentication

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://hydra.demo.ory.sh/oauth2/auth
  • Scopes:
    • offline: A scope required when requesting refresh tokens (alias for `offline_access`)
    • offline_access: A scope required when requesting refresh tokens
    • openid: Request an OpenID Connect ID Token

oryAccessToken

  • Type: Bearer authentication

oryWorkspaceApiKey

  • Type: Bearer authentication

FAQs

Package last updated on 06 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

Maven Central Adds Sigstore Signature Validation

Security News

Maven Central Adds Sigstore Signature Validation

Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.

By Sarah Gooding  -  Feb 06, 2025
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc