Rust API client for ory-kratos-client

Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.

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.

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./generated" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- 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 *V0alpha2Api* | admincreateidentity | POST /admin/identities | Create an Identity *V0alpha2Api* | admincreateselfservicerecoverylink | POST /admin/recovery/link | Create a Recovery Link V0alpha2Api | admindeleteidentity | DELETE /admin/identities/{id} | Delete an Identity V0alpha2Api | admindeleteidentitysessions | DELETE /admin/identities/{id}/sessions | Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. *V0alpha2Api* | admingetidentity | GET /admin/identities/{id} | Get an Identity *V0alpha2Api* | adminlistidentities | GET /admin/identities | List Identities *V0alpha2Api* | adminlistidentitysessions | GET /admin/identities/{id}/sessions | This endpoint returns all sessions that belong to the given Identity. V0alpha2Api | adminupdateidentity | PUT /admin/identities/{id} | Update an Identity V0alpha2Api | createselfservicelogoutflowurlforbrowsers | GET /self-service/logout/browser | Create a Logout URL for Browsers *V0alpha2Api* | getjsonschema | GET /schemas/{id} | *V0alpha2Api* | getselfserviceerror | GET /self-service/errors | Get Self-Service Errors V0alpha2Api | getselfserviceloginflow | GET /self-service/login/flows | Get Login Flow V0alpha2Api | getselfservicerecoveryflow | GET /self-service/recovery/flows | Get Recovery Flow V0alpha2Api | getselfserviceregistrationflow | GET /self-service/registration/flows | Get Registration Flow V0alpha2Api | getselfservicesettingsflow | GET /self-service/settings/flows | Get Settings Flow V0alpha2Api | getselfserviceverificationflow | GET /self-service/verification/flows | Get Verification Flow V0alpha2Api | getwebauthnjavascript | GET /.well-known/ory/webauthn.js | Get WebAuthn JavaScript V0alpha2Api | initializeselfserviceloginflowforbrowsers | GET /self-service/login/browser | Initialize Login Flow for Browsers V0alpha2Api | initializeselfserviceloginflowwithoutbrowser | GET /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... V0alpha2Api | initializeselfservicerecoveryflowforbrowsers | GET /self-service/recovery/browser | Initialize Recovery Flow for Browsers V0alpha2Api | initializeselfservicerecoveryflowwithoutbrowser | GET /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... V0alpha2Api | initializeselfserviceregistrationflowforbrowsers | GET /self-service/registration/browser | Initialize Registration Flow for Browsers V0alpha2Api | initializeselfserviceregistrationflowwithoutbrowser | GET /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... V0alpha2Api | initializeselfservicesettingsflowforbrowsers | GET /self-service/settings/browser | Initialize Settings Flow for Browsers V0alpha2Api | initializeselfservicesettingsflowwithoutbrowser | GET /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... V0alpha2Api | initializeselfserviceverificationflowforbrowsers | GET /self-service/verification/browser | Initialize Verification Flow for Browser Clients V0alpha2Api | initializeselfserviceverificationflowwithoutbrowser | GET /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... V0alpha2Api | listidentityschemas | GET /schemas | V0alpha2Api | listsessions | GET /sessions | This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the /sessions/whoami endpoint. *V0alpha2Api* | revokesession | DELETE /sessions/{id} | Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. V0alpha2Api | revokesessions | DELETE /sessions | Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. *V0alpha2Api* | submitselfserviceloginflow | POST /self-service/login | Submit a Login Flow *V0alpha2Api* | submitselfservicelogoutflow | GET /self-service/logout | Complete Self-Service Logout *V0alpha2Api* | submitselfservicelogoutflowwithoutbrowser | DELETE /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... *V0alpha2Api* | submitselfservicerecoveryflow | POST /self-service/recovery | Complete Recovery Flow *V0alpha2Api* | submitselfserviceregistrationflow | POST /self-service/registration | Submit a Registration Flow *V0alpha2Api* | submitselfservicesettingsflow | POST /self-service/settings | Complete Settings Flow *V0alpha2Api* | submitselfserviceverificationflow | POST /self-service/verification | Complete Verification Flow *V0alpha2Api* | tosession | GET /sessions/whoami | Check Who the Current HTTP Session Belongs To

Documentation For Models

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

cargo doc --open

Author

hi@ory.sh