# 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](https://openapi-generator.tech) project:

- API version: v1.1.46
- Package version: v1.1.46
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build ory-client.gemspec
```

Then either install the gem locally:

```shell
gem install ./ory-client-v1.1.46.gem
```

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

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'ory-client', '~> v1.1.46'

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

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'ory-client'

# Setup authorization
OryClient.configure do |config|
  # Configure Bearer authorization: oryAccessToken
  config.access_token = 'YOUR_BEARER_TOKEN'
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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*OryClient::CourierApi* | [**get_courier_message**](docs/CourierApi.md#get_courier_message) | **GET** /admin/courier/messages/{id} | Get a Message
*OryClient::CourierApi* | [**list_courier_messages**](docs/CourierApi.md#list_courier_messages) | **GET** /admin/courier/messages | List Messages
*OryClient::FrontendApi* | [**create_browser_login_flow**](docs/FrontendApi.md#create_browser_login_flow) | **GET** /self-service/login/browser | Create Login Flow for Browsers
*OryClient::FrontendApi* | [**create_browser_logout_flow**](docs/FrontendApi.md#create_browser_logout_flow) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers
*OryClient::FrontendApi* | [**create_browser_recovery_flow**](docs/FrontendApi.md#create_browser_recovery_flow) | **GET** /self-service/recovery/browser | Create Recovery Flow for Browsers
*OryClient::FrontendApi* | [**create_browser_registration_flow**](docs/FrontendApi.md#create_browser_registration_flow) | **GET** /self-service/registration/browser | Create Registration Flow for Browsers
*OryClient::FrontendApi* | [**create_browser_settings_flow**](docs/FrontendApi.md#create_browser_settings_flow) | **GET** /self-service/settings/browser | Create Settings Flow for Browsers
*OryClient::FrontendApi* | [**create_browser_verification_flow**](docs/FrontendApi.md#create_browser_verification_flow) | **GET** /self-service/verification/browser | Create Verification Flow for Browser Clients
*OryClient::FrontendApi* | [**create_native_login_flow**](docs/FrontendApi.md#create_native_login_flow) | **GET** /self-service/login/api | Create Login Flow for Native Apps
*OryClient::FrontendApi* | [**create_native_recovery_flow**](docs/FrontendApi.md#create_native_recovery_flow) | **GET** /self-service/recovery/api | Create Recovery Flow for Native Apps
*OryClient::FrontendApi* | [**create_native_registration_flow**](docs/FrontendApi.md#create_native_registration_flow) | **GET** /self-service/registration/api | Create Registration Flow for Native Apps
*OryClient::FrontendApi* | [**create_native_settings_flow**](docs/FrontendApi.md#create_native_settings_flow) | **GET** /self-service/settings/api | Create Settings Flow for Native Apps
*OryClient::FrontendApi* | [**create_native_verification_flow**](docs/FrontendApi.md#create_native_verification_flow) | **GET** /self-service/verification/api | Create Verification Flow for Native Apps
*OryClient::FrontendApi* | [**disable_my_other_sessions**](docs/FrontendApi.md#disable_my_other_sessions) | **DELETE** /sessions | Disable my other sessions
*OryClient::FrontendApi* | [**disable_my_session**](docs/FrontendApi.md#disable_my_session) | **DELETE** /sessions/{id} | Disable one of my sessions
*OryClient::FrontendApi* | [**exchange_session_token**](docs/FrontendApi.md#exchange_session_token) | **GET** /sessions/token-exchange | Exchange Session Token
*OryClient::FrontendApi* | [**get_flow_error**](docs/FrontendApi.md#get_flow_error) | **GET** /self-service/errors | Get User-Flow Errors
*OryClient::FrontendApi* | [**get_login_flow**](docs/FrontendApi.md#get_login_flow) | **GET** /self-service/login/flows | Get Login Flow
*OryClient::FrontendApi* | [**get_recovery_flow**](docs/FrontendApi.md#get_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow
*OryClient::FrontendApi* | [**get_registration_flow**](docs/FrontendApi.md#get_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
*OryClient::FrontendApi* | [**get_settings_flow**](docs/FrontendApi.md#get_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
*OryClient::FrontendApi* | [**get_verification_flow**](docs/FrontendApi.md#get_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
*OryClient::FrontendApi* | [**get_web_authn_java_script**](docs/FrontendApi.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript
*OryClient::FrontendApi* | [**list_my_sessions**](docs/FrontendApi.md#list_my_sessions) | **GET** /sessions | Get My Active Sessions
*OryClient::FrontendApi* | [**perform_native_logout**](docs/FrontendApi.md#perform_native_logout) | **DELETE** /self-service/logout/api | Perform Logout for Native Apps
*OryClient::FrontendApi* | [**to_session**](docs/FrontendApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
*OryClient::FrontendApi* | [**update_login_flow**](docs/FrontendApi.md#update_login_flow) | **POST** /self-service/login | Submit a Login Flow
*OryClient::FrontendApi* | [**update_logout_flow**](docs/FrontendApi.md#update_logout_flow) | **GET** /self-service/logout | Update Logout Flow
*OryClient::FrontendApi* | [**update_recovery_flow**](docs/FrontendApi.md#update_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow
*OryClient::FrontendApi* | [**update_registration_flow**](docs/FrontendApi.md#update_registration_flow) | **POST** /self-service/registration | Update Registration Flow
*OryClient::FrontendApi* | [**update_settings_flow**](docs/FrontendApi.md#update_settings_flow) | **POST** /self-service/settings | Complete Settings Flow
*OryClient::FrontendApi* | [**update_verification_flow**](docs/FrontendApi.md#update_verification_flow) | **POST** /self-service/verification | Complete Verification Flow
*OryClient::IdentityApi* | [**batch_patch_identities**](docs/IdentityApi.md#batch_patch_identities) | **PATCH** /admin/identities | Create and deletes multiple identities
*OryClient::IdentityApi* | [**create_identity**](docs/IdentityApi.md#create_identity) | **POST** /admin/identities | Create an Identity
*OryClient::IdentityApi* | [**create_recovery_code_for_identity**](docs/IdentityApi.md#create_recovery_code_for_identity) | **POST** /admin/recovery/code | Create a Recovery Code
*OryClient::IdentityApi* | [**create_recovery_link_for_identity**](docs/IdentityApi.md#create_recovery_link_for_identity) | **POST** /admin/recovery/link | Create a Recovery Link
*OryClient::IdentityApi* | [**delete_identity**](docs/IdentityApi.md#delete_identity) | **DELETE** /admin/identities/{id} | Delete an Identity
*OryClient::IdentityApi* | [**delete_identity_credentials**](docs/IdentityApi.md#delete_identity_credentials) | **DELETE** /admin/identities/{id}/credentials/{type} | Delete a credential for a specific identity
*OryClient::IdentityApi* | [**delete_identity_sessions**](docs/IdentityApi.md#delete_identity_sessions) | **DELETE** /admin/identities/{id}/sessions | Delete & Invalidate an Identity's Sessions
*OryClient::IdentityApi* | [**disable_session**](docs/IdentityApi.md#disable_session) | **DELETE** /admin/sessions/{id} | Deactivate a Session
*OryClient::IdentityApi* | [**extend_session**](docs/IdentityApi.md#extend_session) | **PATCH** /admin/sessions/{id}/extend | Extend a Session
*OryClient::IdentityApi* | [**get_identity**](docs/IdentityApi.md#get_identity) | **GET** /admin/identities/{id} | Get an Identity
*OryClient::IdentityApi* | [**get_identity_schema**](docs/IdentityApi.md#get_identity_schema) | **GET** /schemas/{id} | Get Identity JSON Schema
*OryClient::IdentityApi* | [**get_session**](docs/IdentityApi.md#get_session) | **GET** /admin/sessions/{id} | Get Session
*OryClient::IdentityApi* | [**list_identities**](docs/IdentityApi.md#list_identities) | **GET** /admin/identities | List Identities
*OryClient::IdentityApi* | [**list_identity_schemas**](docs/IdentityApi.md#list_identity_schemas) | **GET** /schemas | Get all Identity Schemas
*OryClient::IdentityApi* | [**list_identity_sessions**](docs/IdentityApi.md#list_identity_sessions) | **GET** /admin/identities/{id}/sessions | List an Identity's Sessions
*OryClient::IdentityApi* | [**list_sessions**](docs/IdentityApi.md#list_sessions) | **GET** /admin/sessions | List All Sessions
*OryClient::IdentityApi* | [**patch_identity**](docs/IdentityApi.md#patch_identity) | **PATCH** /admin/identities/{id} | Patch an Identity
*OryClient::IdentityApi* | [**update_identity**](docs/IdentityApi.md#update_identity) | **PUT** /admin/identities/{id} | Update an Identity
*OryClient::JwkApi* | [**create_json_web_key_set**](docs/JwkApi.md#create_json_web_key_set) | **POST** /admin/keys/{set} | Create JSON Web Key
*OryClient::JwkApi* | [**delete_json_web_key**](docs/JwkApi.md#delete_json_web_key) | **DELETE** /admin/keys/{set}/{kid} | Delete JSON Web Key
*OryClient::JwkApi* | [**delete_json_web_key_set**](docs/JwkApi.md#delete_json_web_key_set) | **DELETE** /admin/keys/{set} | Delete JSON Web Key Set
*OryClient::JwkApi* | [**get_json_web_key**](docs/JwkApi.md#get_json_web_key) | **GET** /admin/keys/{set}/{kid} | Get JSON Web Key
*OryClient::JwkApi* | [**get_json_web_key_set**](docs/JwkApi.md#get_json_web_key_set) | **GET** /admin/keys/{set} | Retrieve a JSON Web Key Set
*OryClient::JwkApi* | [**set_json_web_key**](docs/JwkApi.md#set_json_web_key) | **PUT** /admin/keys/{set}/{kid} | Set JSON Web Key
*OryClient::JwkApi* | [**set_json_web_key_set**](docs/JwkApi.md#set_json_web_key_set) | **PUT** /admin/keys/{set} | Update a JSON Web Key Set
*OryClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version.
*OryClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status
*OryClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status
*OryClient::OAuth2Api* | [**accept_o_auth2_consent_request**](docs/OAuth2Api.md#accept_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request
*OryClient::OAuth2Api* | [**accept_o_auth2_login_request**](docs/OAuth2Api.md#accept_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request
*OryClient::OAuth2Api* | [**accept_o_auth2_logout_request**](docs/OAuth2Api.md#accept_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request
*OryClient::OAuth2Api* | [**create_o_auth2_client**](docs/OAuth2Api.md#create_o_auth2_client) | **POST** /admin/clients | Create OAuth 2.0 Client
*OryClient::OAuth2Api* | [**delete_o_auth2_client**](docs/OAuth2Api.md#delete_o_auth2_client) | **DELETE** /admin/clients/{id} | Delete OAuth 2.0 Client
*OryClient::OAuth2Api* | [**delete_o_auth2_token**](docs/OAuth2Api.md#delete_o_auth2_token) | **DELETE** /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
*OryClient::OAuth2Api* | [**delete_trusted_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#delete_trusted_o_auth2_jwt_grant_issuer) | **DELETE** /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
*OryClient::OAuth2Api* | [**get_o_auth2_client**](docs/OAuth2Api.md#get_o_auth2_client) | **GET** /admin/clients/{id} | Get an OAuth 2.0 Client
*OryClient::OAuth2Api* | [**get_o_auth2_consent_request**](docs/OAuth2Api.md#get_o_auth2_consent_request) | **GET** /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request
*OryClient::OAuth2Api* | [**get_o_auth2_login_request**](docs/OAuth2Api.md#get_o_auth2_login_request) | **GET** /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request
*OryClient::OAuth2Api* | [**get_o_auth2_logout_request**](docs/OAuth2Api.md#get_o_auth2_logout_request) | **GET** /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request
*OryClient::OAuth2Api* | [**get_trusted_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#get_trusted_o_auth2_jwt_grant_issuer) | **GET** /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer
*OryClient::OAuth2Api* | [**introspect_o_auth2_token**](docs/OAuth2Api.md#introspect_o_auth2_token) | **POST** /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens
*OryClient::OAuth2Api* | [**list_o_auth2_clients**](docs/OAuth2Api.md#list_o_auth2_clients) | **GET** /admin/clients | List OAuth 2.0 Clients
*OryClient::OAuth2Api* | [**list_o_auth2_consent_sessions**](docs/OAuth2Api.md#list_o_auth2_consent_sessions) | **GET** /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject
*OryClient::OAuth2Api* | [**list_trusted_o_auth2_jwt_grant_issuers**](docs/OAuth2Api.md#list_trusted_o_auth2_jwt_grant_issuers) | **GET** /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers
*OryClient::OAuth2Api* | [**o_auth2_authorize**](docs/OAuth2Api.md#o_auth2_authorize) | **GET** /oauth2/auth | OAuth 2.0 Authorize Endpoint
*OryClient::OAuth2Api* | [**oauth2_token_exchange**](docs/OAuth2Api.md#oauth2_token_exchange) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint
*OryClient::OAuth2Api* | [**patch_o_auth2_client**](docs/OAuth2Api.md#patch_o_auth2_client) | **PATCH** /admin/clients/{id} | Patch OAuth 2.0 Client
*OryClient::OAuth2Api* | [**reject_o_auth2_consent_request**](docs/OAuth2Api.md#reject_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request
*OryClient::OAuth2Api* | [**reject_o_auth2_login_request**](docs/OAuth2Api.md#reject_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request
*OryClient::OAuth2Api* | [**reject_o_auth2_logout_request**](docs/OAuth2Api.md#reject_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request
*OryClient::OAuth2Api* | [**revoke_o_auth2_consent_sessions**](docs/OAuth2Api.md#revoke_o_auth2_consent_sessions) | **DELETE** /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject
*OryClient::OAuth2Api* | [**revoke_o_auth2_login_sessions**](docs/OAuth2Api.md#revoke_o_auth2_login_sessions) | **DELETE** /admin/oauth2/auth/sessions/login | Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
*OryClient::OAuth2Api* | [**revoke_o_auth2_token**](docs/OAuth2Api.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token
*OryClient::OAuth2Api* | [**set_o_auth2_client**](docs/OAuth2Api.md#set_o_auth2_client) | **PUT** /admin/clients/{id} | Set OAuth 2.0 Client
*OryClient::OAuth2Api* | [**set_o_auth2_client_lifespans**](docs/OAuth2Api.md#set_o_auth2_client_lifespans) | **PUT** /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans
*OryClient::OAuth2Api* | [**trust_o_auth2_jwt_grant_issuer**](docs/OAuth2Api.md#trust_o_auth2_jwt_grant_issuer) | **POST** /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer
*OryClient::OidcApi* | [**create_oidc_dynamic_client**](docs/OidcApi.md#create_oidc_dynamic_client) | **POST** /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration
*OryClient::OidcApi* | [**create_verifiable_credential**](docs/OidcApi.md#create_verifiable_credential) | **POST** /credentials | Issues a Verifiable Credential
*OryClient::OidcApi* | [**delete_oidc_dynamic_client**](docs/OidcApi.md#delete_oidc_dynamic_client) | **DELETE** /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
*OryClient::OidcApi* | [**discover_oidc_configuration**](docs/OidcApi.md#discover_oidc_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
*OryClient::OidcApi* | [**get_oidc_dynamic_client**](docs/OidcApi.md#get_oidc_dynamic_client) | **GET** /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration
*OryClient::OidcApi* | [**get_oidc_user_info**](docs/OidcApi.md#get_oidc_user_info) | **GET** /userinfo | OpenID Connect Userinfo
*OryClient::OidcApi* | [**revoke_oidc_session**](docs/OidcApi.md#revoke_oidc_session) | **GET** /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout
*OryClient::OidcApi* | [**set_oidc_dynamic_client**](docs/OidcApi.md#set_oidc_dynamic_client) | **PUT** /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration
*OryClient::PermissionApi* | [**check_permission**](docs/PermissionApi.md#check_permission) | **GET** /relation-tuples/check/openapi | Check a permission
*OryClient::PermissionApi* | [**check_permission_or_error**](docs/PermissionApi.md#check_permission_or_error) | **GET** /relation-tuples/check | Check a permission
*OryClient::PermissionApi* | [**expand_permissions**](docs/PermissionApi.md#expand_permissions) | **GET** /relation-tuples/expand | Expand a Relationship into permissions.
*OryClient::PermissionApi* | [**post_check_permission**](docs/PermissionApi.md#post_check_permission) | **POST** /relation-tuples/check/openapi | Check a permission
*OryClient::PermissionApi* | [**post_check_permission_or_error**](docs/PermissionApi.md#post_check_permission_or_error) | **POST** /relation-tuples/check | Check a permission
*OryClient::ProjectApi* | [**create_project**](docs/ProjectApi.md#create_project) | **POST** /projects | Create a Project
*OryClient::ProjectApi* | [**create_project_api_key**](docs/ProjectApi.md#create_project_api_key) | **POST** /projects/{project}/tokens | Create project API token
*OryClient::ProjectApi* | [**delete_project_api_key**](docs/ProjectApi.md#delete_project_api_key) | **DELETE** /projects/{project}/tokens/{token_id} | Delete project API token
*OryClient::ProjectApi* | [**get_active_project_in_console**](docs/ProjectApi.md#get_active_project_in_console) | **GET** /console/active/project | Returns the Ory Network Project selected in the Ory Network Console
*OryClient::ProjectApi* | [**get_project**](docs/ProjectApi.md#get_project) | **GET** /projects/{project_id} | Get a Project
*OryClient::ProjectApi* | [**get_project_members**](docs/ProjectApi.md#get_project_members) | **GET** /projects/{project}/members | Get all members associated with this project
*OryClient::ProjectApi* | [**get_project_metrics**](docs/ProjectApi.md#get_project_metrics) | **GET** /projects/{project_id}/metrics | 
*OryClient::ProjectApi* | [**list_project_api_keys**](docs/ProjectApi.md#list_project_api_keys) | **GET** /projects/{project}/tokens | List a project's API Tokens
*OryClient::ProjectApi* | [**list_projects**](docs/ProjectApi.md#list_projects) | **GET** /projects | List All Projects
*OryClient::ProjectApi* | [**patch_project**](docs/ProjectApi.md#patch_project) | **PATCH** /projects/{project_id} | Patch an Ory Network Project Configuration
*OryClient::ProjectApi* | [**purge_project**](docs/ProjectApi.md#purge_project) | **DELETE** /projects/{project_id} | Irrecoverably purge a project
*OryClient::ProjectApi* | [**remove_project_member**](docs/ProjectApi.md#remove_project_member) | **DELETE** /projects/{project}/members/{member} | Remove a member associated with this project
*OryClient::ProjectApi* | [**set_active_project_in_console**](docs/ProjectApi.md#set_active_project_in_console) | **PUT** /console/active/project | Sets the Ory Network Project active in the Ory Network Console
*OryClient::ProjectApi* | [**set_project**](docs/ProjectApi.md#set_project) | **PUT** /projects/{project_id} | Update an Ory Network Project Configuration
*OryClient::RelationshipApi* | [**check_opl_syntax**](docs/RelationshipApi.md#check_opl_syntax) | **POST** /opl/syntax/check | Check the syntax of an OPL file
*OryClient::RelationshipApi* | [**create_relationship**](docs/RelationshipApi.md#create_relationship) | **PUT** /admin/relation-tuples | Create a Relationship
*OryClient::RelationshipApi* | [**delete_relationships**](docs/RelationshipApi.md#delete_relationships) | **DELETE** /admin/relation-tuples | Delete Relationships
*OryClient::RelationshipApi* | [**get_relationships**](docs/RelationshipApi.md#get_relationships) | **GET** /relation-tuples | Query relationships
*OryClient::RelationshipApi* | [**list_relationship_namespaces**](docs/RelationshipApi.md#list_relationship_namespaces) | **GET** /namespaces | Query namespaces
*OryClient::RelationshipApi* | [**patch_relationships**](docs/RelationshipApi.md#patch_relationships) | **PATCH** /admin/relation-tuples | Patch Multiple Relationships
*OryClient::WellknownApi* | [**discover_json_web_keys**](docs/WellknownApi.md#discover_json_web_keys) | **GET** /.well-known/jwks.json | Discover Well-Known JSON Web Keys


## Documentation for Models

 - [OryClient::AcceptOAuth2ConsentRequest](docs/AcceptOAuth2ConsentRequest.md)
 - [OryClient::AcceptOAuth2ConsentRequestSession](docs/AcceptOAuth2ConsentRequestSession.md)
 - [OryClient::AcceptOAuth2LoginRequest](docs/AcceptOAuth2LoginRequest.md)
 - [OryClient::ActiveProjectInConsole](docs/ActiveProjectInConsole.md)
 - [OryClient::AuthenticatorAssuranceLevel](docs/AuthenticatorAssuranceLevel.md)
 - [OryClient::BatchPatchIdentitiesResponse](docs/BatchPatchIdentitiesResponse.md)
 - [OryClient::CORS](docs/CORS.md)
 - [OryClient::CheckOplSyntaxResult](docs/CheckOplSyntaxResult.md)
 - [OryClient::CheckPermissionResult](docs/CheckPermissionResult.md)
 - [OryClient::CloudAccount](docs/CloudAccount.md)
 - [OryClient::ContinueWith](docs/ContinueWith.md)
 - [OryClient::ContinueWithSetOrySessionToken](docs/ContinueWithSetOrySessionToken.md)
 - [OryClient::ContinueWithVerificationUi](docs/ContinueWithVerificationUi.md)
 - [OryClient::ContinueWithVerificationUiFlow](docs/ContinueWithVerificationUiFlow.md)
 - [OryClient::CourierMessageStatus](docs/CourierMessageStatus.md)
 - [OryClient::CourierMessageType](docs/CourierMessageType.md)
 - [OryClient::CreateCustomDomainBody](docs/CreateCustomDomainBody.md)
 - [OryClient::CreateIdentityBody](docs/CreateIdentityBody.md)
 - [OryClient::CreateInviteResponse](docs/CreateInviteResponse.md)
 - [OryClient::CreateJsonWebKeySet](docs/CreateJsonWebKeySet.md)
 - [OryClient::CreateProjectApiKeyRequest](docs/CreateProjectApiKeyRequest.md)
 - [OryClient::CreateProjectBody](docs/CreateProjectBody.md)
 - [OryClient::CreateProjectBranding](docs/CreateProjectBranding.md)
 - [OryClient::CreateProjectMemberInviteBody](docs/CreateProjectMemberInviteBody.md)
 - [OryClient::CreateRecoveryCodeForIdentityBody](docs/CreateRecoveryCodeForIdentityBody.md)
 - [OryClient::CreateRecoveryLinkForIdentityBody](docs/CreateRecoveryLinkForIdentityBody.md)
 - [OryClient::CreateRelationshipBody](docs/CreateRelationshipBody.md)
 - [OryClient::CreateSubscriptionBody](docs/CreateSubscriptionBody.md)
 - [OryClient::CreateVerifiableCredentialRequestBody](docs/CreateVerifiableCredentialRequestBody.md)
 - [OryClient::CredentialSupportedDraft00](docs/CredentialSupportedDraft00.md)
 - [OryClient::CustomDomain](docs/CustomDomain.md)
 - [OryClient::DeleteMySessionsCount](docs/DeleteMySessionsCount.md)
 - [OryClient::EmailTemplateData](docs/EmailTemplateData.md)
 - [OryClient::EmailTemplateDataBody](docs/EmailTemplateDataBody.md)
 - [OryClient::ErrorAuthenticatorAssuranceLevelNotSatisfied](docs/ErrorAuthenticatorAssuranceLevelNotSatisfied.md)
 - [OryClient::ErrorBrowserLocationChangeRequired](docs/ErrorBrowserLocationChangeRequired.md)
 - [OryClient::ErrorFlowReplaced](docs/ErrorFlowReplaced.md)
 - [OryClient::ErrorGeneric](docs/ErrorGeneric.md)
 - [OryClient::ErrorOAuth2](docs/ErrorOAuth2.md)
 - [OryClient::ExpandedPermissionTree](docs/ExpandedPermissionTree.md)
 - [OryClient::FlowError](docs/FlowError.md)
 - [OryClient::GenericError](docs/GenericError.md)
 - [OryClient::GenericErrorContent](docs/GenericErrorContent.md)
 - [OryClient::GenericUsage](docs/GenericUsage.md)
 - [OryClient::GetManagedIdentitySchemaLocation](docs/GetManagedIdentitySchemaLocation.md)
 - [OryClient::GetProjectMetricsResponse](docs/GetProjectMetricsResponse.md)
 - [OryClient::GetVersion200Response](docs/GetVersion200Response.md)
 - [OryClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
 - [OryClient::HealthStatus](docs/HealthStatus.md)
 - [OryClient::Identity](docs/Identity.md)
 - [OryClient::IdentityCredentials](docs/IdentityCredentials.md)
 - [OryClient::IdentityCredentialsOidc](docs/IdentityCredentialsOidc.md)
 - [OryClient::IdentityCredentialsOidcProvider](docs/IdentityCredentialsOidcProvider.md)
 - [OryClient::IdentityCredentialsPassword](docs/IdentityCredentialsPassword.md)
 - [OryClient::IdentityCredentialsType](docs/IdentityCredentialsType.md)
 - [OryClient::IdentityPatch](docs/IdentityPatch.md)
 - [OryClient::IdentityPatchResponse](docs/IdentityPatchResponse.md)
 - [OryClient::IdentitySchemaContainer](docs/IdentitySchemaContainer.md)
 - [OryClient::IdentitySchemaPreset](docs/IdentitySchemaPreset.md)
 - [OryClient::IdentityState](docs/IdentityState.md)
 - [OryClient::IdentityWithCredentials](docs/IdentityWithCredentials.md)
 - [OryClient::IdentityWithCredentialsOidc](docs/IdentityWithCredentialsOidc.md)
 - [OryClient::IdentityWithCredentialsOidcConfig](docs/IdentityWithCredentialsOidcConfig.md)
 - [OryClient::IdentityWithCredentialsOidcConfigProvider](docs/IdentityWithCredentialsOidcConfigProvider.md)
 - [OryClient::IdentityWithCredentialsPassword](docs/IdentityWithCredentialsPassword.md)
 - [OryClient::IdentityWithCredentialsPasswordConfig](docs/IdentityWithCredentialsPasswordConfig.md)
 - [OryClient::InternalGetProjectBrandingBody](docs/InternalGetProjectBrandingBody.md)
 - [OryClient::InternalIsAXWelcomeScreenEnabledForProjectBody](docs/InternalIsAXWelcomeScreenEnabledForProjectBody.md)
 - [OryClient::InternalIsOwnerForProjectBySlugBody](docs/InternalIsOwnerForProjectBySlugBody.md)
 - [OryClient::InternalIsOwnerForProjectBySlugResponse](docs/InternalIsOwnerForProjectBySlugResponse.md)
 - [OryClient::InternalProvisionMockSubscription](docs/InternalProvisionMockSubscription.md)
 - [OryClient::IntrospectedOAuth2Token](docs/IntrospectedOAuth2Token.md)
 - [OryClient::IsOwnerForProjectBySlug](docs/IsOwnerForProjectBySlug.md)
 - [OryClient::IsReady200Response](docs/IsReady200Response.md)
 - [OryClient::IsReady503Response](docs/IsReady503Response.md)
 - [OryClient::JsonPatch](docs/JsonPatch.md)
 - [OryClient::JsonWebKey](docs/JsonWebKey.md)
 - [OryClient::JsonWebKeySet](docs/JsonWebKeySet.md)
 - [OryClient::KetoNamespace](docs/KetoNamespace.md)
 - [OryClient::LoginFlow](docs/LoginFlow.md)
 - [OryClient::LogoutFlow](docs/LogoutFlow.md)
 - [OryClient::ManagedIdentitySchema](docs/ManagedIdentitySchema.md)
 - [OryClient::ManagedIdentitySchemaValidationResult](docs/ManagedIdentitySchemaValidationResult.md)
 - [OryClient::MemberInvite](docs/MemberInvite.md)
 - [OryClient::Message](docs/Message.md)
 - [OryClient::MessageDispatch](docs/MessageDispatch.md)
 - [OryClient::MetricsDatapoint](docs/MetricsDatapoint.md)
 - [OryClient::Namespace](docs/Namespace.md)
 - [OryClient::NeedsPrivilegedSessionError](docs/NeedsPrivilegedSessionError.md)
 - [OryClient::NormalizedProject](docs/NormalizedProject.md)
 - [OryClient::NormalizedProjectRevision](docs/NormalizedProjectRevision.md)
 - [OryClient::NormalizedProjectRevisionHook](docs/NormalizedProjectRevisionHook.md)
 - [OryClient::NormalizedProjectRevisionIdentitySchema](docs/NormalizedProjectRevisionIdentitySchema.md)
 - [OryClient::NormalizedProjectRevisionThirdPartyProvider](docs/NormalizedProjectRevisionThirdPartyProvider.md)
 - [OryClient::OAuth2Client](docs/OAuth2Client.md)
 - [OryClient::OAuth2ClientTokenLifespans](docs/OAuth2ClientTokenLifespans.md)
 - [OryClient::OAuth2ConsentRequest](docs/OAuth2ConsentRequest.md)
 - [OryClient::OAuth2ConsentRequestOpenIDConnectContext](docs/OAuth2ConsentRequestOpenIDConnectContext.md)
 - [OryClient::OAuth2ConsentSession](docs/OAuth2ConsentSession.md)
 - [OryClient::OAuth2ConsentSessionExpiresAt](docs/OAuth2ConsentSessionExpiresAt.md)
 - [OryClient::OAuth2LoginRequest](docs/OAuth2LoginRequest.md)
 - [OryClient::OAuth2LogoutRequest](docs/OAuth2LogoutRequest.md)
 - [OryClient::OAuth2RedirectTo](docs/OAuth2RedirectTo.md)
 - [OryClient::OAuth2TokenExchange](docs/OAuth2TokenExchange.md)
 - [OryClient::OidcConfiguration](docs/OidcConfiguration.md)
 - [OryClient::OidcUserInfo](docs/OidcUserInfo.md)
 - [OryClient::Pagination](docs/Pagination.md)
 - [OryClient::PaginationHeaders](docs/PaginationHeaders.md)
 - [OryClient::ParseError](docs/ParseError.md)
 - [OryClient::PatchIdentitiesBody](docs/PatchIdentitiesBody.md)
 - [OryClient::PerformNativeLogoutBody](docs/PerformNativeLogoutBody.md)
 - [OryClient::Plan](docs/Plan.md)
 - [OryClient::PlanDetails](docs/PlanDetails.md)
 - [OryClient::PostCheckPermissionBody](docs/PostCheckPermissionBody.md)
 - [OryClient::PostCheckPermissionOrErrorBody](docs/PostCheckPermissionOrErrorBody.md)
 - [OryClient::Project](docs/Project.md)
 - [OryClient::ProjectApiKey](docs/ProjectApiKey.md)
 - [OryClient::ProjectBranding](docs/ProjectBranding.md)
 - [OryClient::ProjectBrandingColors](docs/ProjectBrandingColors.md)
 - [OryClient::ProjectBrandingTheme](docs/ProjectBrandingTheme.md)
 - [OryClient::ProjectHost](docs/ProjectHost.md)
 - [OryClient::ProjectMetadata](docs/ProjectMetadata.md)
 - [OryClient::ProjectServiceIdentity](docs/ProjectServiceIdentity.md)
 - [OryClient::ProjectServiceOAuth2](docs/ProjectServiceOAuth2.md)
 - [OryClient::ProjectServicePermission](docs/ProjectServicePermission.md)
 - [OryClient::ProjectServices](docs/ProjectServices.md)
 - [OryClient::QuotaUsage](docs/QuotaUsage.md)
 - [OryClient::RFC6749ErrorJson](docs/RFC6749ErrorJson.md)
 - [OryClient::RecoveryCodeForIdentity](docs/RecoveryCodeForIdentity.md)
 - [OryClient::RecoveryFlow](docs/RecoveryFlow.md)
 - [OryClient::RecoveryFlowState](docs/RecoveryFlowState.md)
 - [OryClient::RecoveryIdentityAddress](docs/RecoveryIdentityAddress.md)
 - [OryClient::RecoveryLinkForIdentity](docs/RecoveryLinkForIdentity.md)
 - [OryClient::RegistrationFlow](docs/RegistrationFlow.md)
 - [OryClient::RejectOAuth2Request](docs/RejectOAuth2Request.md)
 - [OryClient::RelationQuery](docs/RelationQuery.md)
 - [OryClient::Relationship](docs/Relationship.md)
 - [OryClient::RelationshipNamespaces](docs/RelationshipNamespaces.md)
 - [OryClient::RelationshipPatch](docs/RelationshipPatch.md)
 - [OryClient::Relationships](docs/Relationships.md)
 - [OryClient::SchemaPatch](docs/SchemaPatch.md)
 - [OryClient::SelfServiceFlowExpiredError](docs/SelfServiceFlowExpiredError.md)
 - [OryClient::Session](docs/Session.md)
 - [OryClient::SessionAuthenticationMethod](docs/SessionAuthenticationMethod.md)
 - [OryClient::SessionDevice](docs/SessionDevice.md)
 - [OryClient::SetActiveProjectInConsoleBody](docs/SetActiveProjectInConsoleBody.md)
 - [OryClient::SetCustomDomainBody](docs/SetCustomDomainBody.md)
 - [OryClient::SetProject](docs/SetProject.md)
 - [OryClient::SetProjectBrandingThemeBody](docs/SetProjectBrandingThemeBody.md)
 - [OryClient::SettingsFlow](docs/SettingsFlow.md)
 - [OryClient::SettingsFlowState](docs/SettingsFlowState.md)
 - [OryClient::SourcePosition](docs/SourcePosition.md)
 - [OryClient::StripeCustomer](docs/StripeCustomer.md)
 - [OryClient::SubjectSet](docs/SubjectSet.md)
 - [OryClient::Subscription](docs/Subscription.md)
 - [OryClient::SuccessfulCodeExchangeResponse](docs/SuccessfulCodeExchangeResponse.md)
 - [OryClient::SuccessfulNativeLogin](docs/SuccessfulNativeLogin.md)
 - [OryClient::SuccessfulNativeRegistration](docs/SuccessfulNativeRegistration.md)
 - [OryClient::SuccessfulProjectUpdate](docs/SuccessfulProjectUpdate.md)
 - [OryClient::TokenPagination](docs/TokenPagination.md)
 - [OryClient::TokenPaginationHeaders](docs/TokenPaginationHeaders.md)
 - [OryClient::TokenPaginationRequestParameters](docs/TokenPaginationRequestParameters.md)
 - [OryClient::TokenPaginationResponseHeaders](docs/TokenPaginationResponseHeaders.md)
 - [OryClient::TrustOAuth2JwtGrantIssuer](docs/TrustOAuth2JwtGrantIssuer.md)
 - [OryClient::TrustedOAuth2JwtGrantIssuer](docs/TrustedOAuth2JwtGrantIssuer.md)
 - [OryClient::TrustedOAuth2JwtGrantJsonWebKey](docs/TrustedOAuth2JwtGrantJsonWebKey.md)
 - [OryClient::UiContainer](docs/UiContainer.md)
 - [OryClient::UiNode](docs/UiNode.md)
 - [OryClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md)
 - [OryClient::UiNodeAttributes](docs/UiNodeAttributes.md)
 - [OryClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md)
 - [OryClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
 - [OryClient::UiNodeMeta](docs/UiNodeMeta.md)
 - [OryClient::UiNodeScriptAttributes](docs/UiNodeScriptAttributes.md)
 - [OryClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md)
 - [OryClient::UiText](docs/UiText.md)
 - [OryClient::UpdateIdentityBody](docs/UpdateIdentityBody.md)
 - [OryClient::UpdateLoginFlowBody](docs/UpdateLoginFlowBody.md)
 - [OryClient::UpdateLoginFlowWithLookupSecretMethod](docs/UpdateLoginFlowWithLookupSecretMethod.md)
 - [OryClient::UpdateLoginFlowWithOidcMethod](docs/UpdateLoginFlowWithOidcMethod.md)
 - [OryClient::UpdateLoginFlowWithPasswordMethod](docs/UpdateLoginFlowWithPasswordMethod.md)
 - [OryClient::UpdateLoginFlowWithTotpMethod](docs/UpdateLoginFlowWithTotpMethod.md)
 - [OryClient::UpdateLoginFlowWithWebAuthnMethod](docs/UpdateLoginFlowWithWebAuthnMethod.md)
 - [OryClient::UpdateRecoveryFlowBody](docs/UpdateRecoveryFlowBody.md)
 - [OryClient::UpdateRecoveryFlowWithCodeMethod](docs/UpdateRecoveryFlowWithCodeMethod.md)
 - [OryClient::UpdateRecoveryFlowWithLinkMethod](docs/UpdateRecoveryFlowWithLinkMethod.md)
 - [OryClient::UpdateRegistrationFlowBody](docs/UpdateRegistrationFlowBody.md)
 - [OryClient::UpdateRegistrationFlowWithOidcMethod](docs/UpdateRegistrationFlowWithOidcMethod.md)
 - [OryClient::UpdateRegistrationFlowWithPasswordMethod](docs/UpdateRegistrationFlowWithPasswordMethod.md)
 - [OryClient::UpdateRegistrationFlowWithWebAuthnMethod](docs/UpdateRegistrationFlowWithWebAuthnMethod.md)
 - [OryClient::UpdateSettingsFlowBody](docs/UpdateSettingsFlowBody.md)
 - [OryClient::UpdateSettingsFlowWithLookupMethod](docs/UpdateSettingsFlowWithLookupMethod.md)
 - [OryClient::UpdateSettingsFlowWithOidcMethod](docs/UpdateSettingsFlowWithOidcMethod.md)
 - [OryClient::UpdateSettingsFlowWithPasswordMethod](docs/UpdateSettingsFlowWithPasswordMethod.md)
 - [OryClient::UpdateSettingsFlowWithProfileMethod](docs/UpdateSettingsFlowWithProfileMethod.md)
 - [OryClient::UpdateSettingsFlowWithTotpMethod](docs/UpdateSettingsFlowWithTotpMethod.md)
 - [OryClient::UpdateSettingsFlowWithWebAuthnMethod](docs/UpdateSettingsFlowWithWebAuthnMethod.md)
 - [OryClient::UpdateSubscriptionBody](docs/UpdateSubscriptionBody.md)
 - [OryClient::UpdateVerificationFlowBody](docs/UpdateVerificationFlowBody.md)
 - [OryClient::UpdateVerificationFlowWithCodeMethod](docs/UpdateVerificationFlowWithCodeMethod.md)
 - [OryClient::UpdateVerificationFlowWithLinkMethod](docs/UpdateVerificationFlowWithLinkMethod.md)
 - [OryClient::Usage](docs/Usage.md)
 - [OryClient::VerifiableCredentialPrimingResponse](docs/VerifiableCredentialPrimingResponse.md)
 - [OryClient::VerifiableCredentialProof](docs/VerifiableCredentialProof.md)
 - [OryClient::VerifiableCredentialResponse](docs/VerifiableCredentialResponse.md)
 - [OryClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md)
 - [OryClient::VerificationFlow](docs/VerificationFlow.md)
 - [OryClient::VerificationFlowState](docs/VerificationFlowState.md)
 - [OryClient::Version](docs/Version.md)
 - [OryClient::Warning](docs/Warning.md)


## Documentation for Authorization


### 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