Lib.rs

› Authentication
#access-token #api-client #client-token #ory #identity #endpoint

ory-client

OpenAPI API client for Ory Network, Ory's web-scale API for identity and access control

Owned by hackerman.

254 releases (81 stable)

new 1.17.2 Feb 25, 2025
1.9.0 Mar 18, 2024
1.6.2 Feb 19, 2024
1.4.7 Dec 20, 2023
0.0.1-alpha.16 Jul 21, 2021

#32 in Authentication

Download history 153/week @ 2024-10-29 883/week @ 2024-11-05 869/week @ 2024-11-12 912/week @ 2024-11-19 1148/week @ 2024-11-26 925/week @ 2024-12-03 701/week @ 2024-12-10 431/week @ 2024-12-17 111/week @ 2024-12-24 207/week @ 2024-12-31 342/week @ 2025-01-07 661/week @ 2025-01-14 770/week @ 2025-01-21 1214/week @ 2025-01-28 1166/week @ 2025-02-04 949/week @ 2025-02-11

4,252 downloads per month

Apache-2.0

2MB
16K SLoC

Rust API client for ory-client

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:

Language Download SDK Documentation
Dart pub.dev README
.NET nuget.org README
Elixir hex.pm README
Go github.com README
Java maven.org README
JavaScript npmjs.com README
JavaScript (With fetch) npmjs.com README
PHP packagist.org README
Python pypi.org README
Ruby rubygems.org README
Rust crates.io README

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v1.17.2
  • Package version: v1.17.2
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named ory-client and add the following to Cargo.toml under [dependencies]:

ory-client = { path = "./ory-client" }

Documentation for API Endpoints

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

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

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@ory.sh

Dependencies

~8–20MB
~276K SLoC