This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more.
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-kratos-client and add the following to Cargo.toml under [dependencies]:
ory-kratos-client = { path = "./ory-kratos-client" }
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CourierApi | getcouriermessage | GET /admin/courier/messages/{id} | Get a Message 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* | batchpatchidentities | PATCH /admin/identities | Create and deletes multiple identities *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* | deleteidentitycredentials | DELETE /admin/identities/{id}/credentials/{type} | Delete a credential for a specific 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} | Get Session *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 *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
To get access to the crate's generated documentation, use:
cargo doc --open
office@ory.sh