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 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.
org.openapitools.codegen.languages.RustClientCodegenPut 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" }
All URIs are relative to https://playground.projects.oryapis.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CourierApi | listcouriermessages | GET /admin/courier/messages | List Messages FrontendApi | createbrowserloginflow | GET /self-service/login/browser | Create Login Flow for Browsers *FrontendApi* | createbrowserlogoutflow | GET /self-service/logout/browser | Create a Logout URL for Browsers FrontendApi | createbrowserrecoveryflow | GET /self-service/recovery/browser | Create Recovery Flow for Browsers *FrontendApi* | createbrowserregistrationflow | GET /self-service/registration/browser | Create Registration Flow for Browsers FrontendApi | createbrowsersettingsflow | GET /self-service/settings/browser | Create Settings Flow for Browsers *FrontendApi* | createbrowserverificationflow | GET /self-service/verification/browser | Create Verification Flow for Browser Clients FrontendApi | createnativeloginflow | GET /self-service/login/api | Create Login Flow for Native Apps *FrontendApi* | createnativerecoveryflow | GET /self-service/recovery/api | Create Recovery Flow for Native Apps FrontendApi | createnativeregistrationflow | GET /self-service/registration/api | Create Registration Flow for Native Apps *FrontendApi* | createnativesettingsflow | GET /self-service/settings/api | Create Settings Flow for Native Apps FrontendApi | createnativeverificationflow | GET /self-service/verification/api | Create Verification Flow for Native Apps *FrontendApi* | disablemyothersessions | DELETE /sessions | Disable my other sessions FrontendApi | disablemysession | DELETE /sessions/{id} | Disable one of my sessions FrontendApi | getflowerror | GET /self-service/errors | Get User-Flow Errors FrontendApi | getloginflow | GET /self-service/login/flows | Get Login Flow FrontendApi | getrecoveryflow | GET /self-service/recovery/flows | Get Recovery Flow FrontendApi | getregistrationflow | GET /self-service/registration/flows | Get Registration Flow FrontendApi | getsettingsflow | GET /self-service/settings/flows | Get Settings Flow FrontendApi | getverificationflow | GET /self-service/verification/flows | Get Verification Flow FrontendApi | getwebauthnjavascript | GET /.well-known/ory/webauthn.js | Get WebAuthn JavaScript FrontendApi | listmysessions | GET /sessions | Get My Active Sessions FrontendApi | performnativelogout | DELETE /self-service/logout/api | Perform Logout for Native Apps FrontendApi | tosession | GET /sessions/whoami | Check Who the Current HTTP Session Belongs To *FrontendApi* | updateloginflow | POST /self-service/login | Submit a Login Flow *FrontendApi* | updatelogoutflow | GET /self-service/logout | Update Logout Flow *FrontendApi* | updaterecoveryflow | POST /self-service/recovery | Complete Recovery Flow *FrontendApi* | updateregistrationflow | POST /self-service/registration | Update Registration Flow *FrontendApi* | updatesettingsflow | POST /self-service/settings | Complete Settings Flow *FrontendApi* | updateverificationflow | POST /self-service/verification | Complete Verification Flow *IdentityApi* | createidentity | POST /admin/identities | Create an Identity IdentityApi | createrecoverycodeforidentity | POST /admin/recovery/code | Create a Recovery Code IdentityApi | createrecoverylinkforidentity | POST /admin/recovery/link | Create a Recovery Link IdentityApi | deleteidentity | DELETE /admin/identities/{id} | Delete an Identity *IdentityApi* | deleteidentitysessions | DELETE /admin/identities/{id}/sessions | Delete & Invalidate an Identity's Sessions *IdentityApi* | disablesession | DELETE /admin/sessions/{id} | Deactivate a Session IdentityApi | extendsession | PATCH /admin/sessions/{id}/extend | Extend a Session *IdentityApi* | getidentity | GET /admin/identities/{id} | Get an Identity IdentityApi | getidentityschema | GET /schemas/{id} | Get Identity JSON Schema IdentityApi | getsession | GET /admin/sessions/{id} | This endpoint returns the session object with expandables specified. *IdentityApi* | listidentities | GET /admin/identities | List Identities IdentityApi | listidentityschemas | GET /schemas | Get all Identity Schemas IdentityApi | listidentitysessions | GET /admin/identities/{id}/sessions | List an Identity's Sessions IdentityApi | listsessions | GET /admin/sessions | List All Sessions *IdentityApi* | patchidentity | PATCH /admin/identities/{id} | Patch an Identity IdentityApi | updateidentity | PUT /admin/identities/{id} | Update an Identity *JwkApi* | createjsonwebkeyset | POST /admin/keys/{set} | Create JSON Web Key *JwkApi* | deletejsonwebkey | DELETE /admin/keys/{set}/{kid} | Delete JSON Web Key JwkApi | deletejsonwebkeyset | DELETE /admin/keys/{set} | Delete JSON Web Key Set JwkApi | getjsonwebkey | GET /admin/keys/{set}/{kid} | Get JSON Web Key *JwkApi* | getjsonwebkeyset | GET /admin/keys/{set} | Retrieve a JSON Web Key Set *JwkApi* | setjsonwebkey | PUT /admin/keys/{set}/{kid} | Set JSON Web Key JwkApi | setjsonwebkeyset | PUT /admin/keys/{set} | Update a JSON Web Key Set MetadataApi | getversion | GET /version | Return Running Software Version. *MetadataApi* | isalive | GET /health/alive | Check HTTP Server Status MetadataApi | isready | GET /health/ready | Check HTTP Server and Database Status *OAuth2Api* | acceptoauth2consentrequest | PUT /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request *OAuth2Api* | acceptoauth2loginrequest | PUT /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request *OAuth2Api* | acceptoauth2logoutrequest | PUT /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request *OAuth2Api* | createoauth2client | POST /admin/clients | Create OAuth 2.0 Client OAuth2Api | deleteoauth2client | DELETE /admin/clients/{id} | Delete OAuth 2.0 Client *OAuth2Api* | deleteoauth2token | DELETE /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client OAuth2Api | deletetrustedoauth2jwtgrantissuer | DELETE /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer OAuth2Api | getoauth2client | GET /admin/clients/{id} | Get an OAuth 2.0 Client *OAuth2Api* | getoauth2consentrequest | GET /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request *OAuth2Api* | getoauth2loginrequest | GET /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request *OAuth2Api* | getoauth2logoutrequest | GET /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request *OAuth2Api* | gettrustedoauth2jwtgrantissuer | GET /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer *OAuth2Api* | introspectoauth2token | POST /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens OAuth2Api | listoauth2clients | GET /admin/clients | List OAuth 2.0 Clients *OAuth2Api* | listoauth2consentsessions | GET /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject *OAuth2Api* | listtrustedoauth2jwtgrantissuers | GET /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers *OAuth2Api* | oauth2authorize | GET /oauth2/auth | OAuth 2.0 Authorize Endpoint *OAuth2Api* | oauth2tokenexchange | POST /oauth2/token | The OAuth 2.0 Token Endpoint *OAuth2Api* | patchoauth2client | PATCH /admin/clients/{id} | Patch OAuth 2.0 Client OAuth2Api | rejectoauth2consentrequest | PUT /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request OAuth2Api | rejectoauth2loginrequest | PUT /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request OAuth2Api | rejectoauth2logoutrequest | PUT /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request OAuth2Api | revokeoauth2consentsessions | DELETE /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject OAuth2Api | revokeoauth2loginsessions | DELETE /admin/oauth2/auth/sessions/login | Revokes All OAuth 2.0 Login Sessions of a Subject OAuth2Api | revokeoauth2token | POST /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token *OAuth2Api* | setoauth2client | PUT /admin/clients/{id} | Set OAuth 2.0 Client OAuth2Api | setoauth2clientlifespans | PUT /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans OAuth2Api | trustoauth2jwtgrantissuer | POST /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer *OidcApi* | createoidcdynamicclient | POST /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration OidcApi | deleteoidcdynamicclient | DELETE /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol *OidcApi* | discoveroidcconfiguration | GET /.well-known/openid-configuration | OpenID Connect Discovery *OidcApi* | getoidcdynamicclient | GET /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration OidcApi | getoidcuserinfo | GET /userinfo | OpenID Connect Userinfo *OidcApi* | revokeoidcsession | GET /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout *OidcApi* | setoidcdynamicclient | PUT /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration PermissionApi | checkpermission | GET /relation-tuples/check/openapi | Check a permission *PermissionApi* | checkpermissionorerror | GET /relation-tuples/check | Check a permission PermissionApi | expandpermissions | GET /relation-tuples/expand | Expand a Relationship into permissions. *PermissionApi* | postcheckpermission | POST /relation-tuples/check/openapi | Check a permission *PermissionApi* | postcheckpermissionorerror | POST /relation-tuples/check | Check a permission *ProjectApi* | createproject | POST /projects | Create a Project ProjectApi | createprojectapikey | POST /projects/{project}/tokens | Create project API token *ProjectApi* | deleteprojectapikey | DELETE /projects/{project}/tokens/{tokenid} | Delete project API token *ProjectApi* | getactiveprojectinconsole | GET /console/active/project | Returns the Ory Network Project selected in the Ory Network Console *ProjectApi* | getproject | GET /projects/{projectid} | Get a Project *ProjectApi* | getprojectmembers | GET /projects/{projectid}/members | Get all members associated with this project ProjectApi | listprojectapikeys | GET /projects/{project}/tokens | List a project's API Tokens *ProjectApi* | listprojects | GET /projects | List All Projects ProjectApi | patchproject | PATCH /projects/{projectid} | Patch an Ory Network Project Configuration ProjectApi | purgeproject | DELETE /projects/{projectid} | Irrecoverably purge a project ProjectApi | removeprojectmember | DELETE /projects/{projectid}/members/{memberid} | Remove a member associated with this project ProjectApi | setactiveprojectinconsole | PUT /console/active/project | Sets the Ory Network Project active in the Ory Network Console ProjectApi | setproject | PUT /projects/{projectid} | Update an Ory Network Project Configuration RelationshipApi | checkoplsyntax | POST /opl/syntax/check | Check the syntax of an OPL file RelationshipApi | createrelationship | PUT /admin/relation-tuples | Create a Relationship *RelationshipApi* | deleterelationships | DELETE /admin/relation-tuples | Delete Relationships RelationshipApi | getrelationships | GET /relation-tuples | Query relationships *RelationshipApi* | listrelationshipnamespaces | GET /namespaces | Query namespaces *RelationshipApi* | patchrelationships | PATCH /admin/relation-tuples | Patch Multiple Relationships WellknownApi | discoverjsonweb_keys | GET /.well-known/jwks.json | Discover Well-Known JSON Web Keys
To get access to the crate's generated documentation, use:
cargo doc --open
support@ory.sh