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.
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.
Put the package under your project folder and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./generated" }
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AdminApi | createidentity | post /identities | Create an Identity *AdminApi* | createrecoverylink | post /recovery/link | Create a Recovery Link *AdminApi* | deleteidentity | delete /identities/{id} | Delete an Identity AdminApi | getidentity | get /identities/{id} | Get an Identity *AdminApi* | getschema | get /schemas/{id} | AdminApi | getselfserviceerror | get /self-service/errors | Get User-Facing Self-Service Errors *AdminApi* | getselfserviceloginflow | get /self-service/login/flows | Get Login Flow *AdminApi* | getselfservicerecoveryflow | get /self-service/recovery/flows | Get information about a recovery flow *AdminApi* | getselfserviceregistrationflow | get /self-service/registration/flows | Get Registration Flow *AdminApi* | getselfservicesettingsflow | get /self-service/settings/flows | Get Settings Flow *AdminApi* | getselfserviceverificationflow | get /self-service/verification/flows | Get Verification Flow *AdminApi* | getversion | get /version | Return Running Software Version. AdminApi | isalive | get /health/alive | Check HTTP Server Status *AdminApi* | isready | get /health/ready | Check HTTP Server and Database Status AdminApi | listidentities | get /identities | List Identities *AdminApi* | prometheus | get /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so: *AdminApi* | updateidentity | put /identities/{id} | Update an Identity PublicApi | getschema | get /schemas/{id} | *PublicApi* | getselfserviceerror | get /self-service/errors | Get User-Facing Self-Service Errors PublicApi | getselfserviceloginflow | get /self-service/login/flows | Get Login Flow PublicApi | getselfservicerecoveryflow | get /self-service/recovery/flows | Get information about a recovery flow PublicApi | getselfserviceregistrationflow | get /self-service/registration/flows | Get Registration Flow PublicApi | getselfservicesettingsflow | get /self-service/settings/flows | Get Settings Flow PublicApi | getselfserviceverificationflow | get /self-service/verification/flows | Get Verification Flow PublicApi | initializeselfservicebrowserlogoutflow | get /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow *PublicApi* | initializeselfserviceloginforbrowsers | get /self-service/login/browser | Initialize Login Flow for browsers PublicApi | initializeselfserviceloginfornativeapps | get /self-service/login/api | Initialize Login Flow for Native Apps and API clients PublicApi | initializeselfservicerecoveryforbrowsers | get /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients *PublicApi* | initializeselfservicerecoveryfornativeapps | get /self-service/recovery/api | Initialize Recovery Flow for Native Apps and API clients *PublicApi* | initializeselfserviceregistrationforbrowsers | get /self-service/registration/browser | Initialize Registration Flow for browsers PublicApi | initializeselfserviceregistrationfornativeapps | get /self-service/registration/api | Initialize Registration Flow for Native Apps and API clients PublicApi | initializeselfservicesettingsforbrowsers | get /self-service/settings/browser | Initialize Settings Flow for Browsers *PublicApi* | initializeselfservicesettingsfornativeapps | get /self-service/settings/api | Initialize Settings Flow for Native Apps and API clients *PublicApi* | initializeselfserviceverificationforbrowsers | get /self-service/verification/browser | Initialize Verification Flow for Browser Clients PublicApi | initializeselfserviceverificationfornativeapps | get /self-service/verification/api | Initialize Verification Flow for Native Apps and API clients PublicApi | revokesession | delete /sessions | Initialize Logout Flow for API Clients - Revoke a Session *PublicApi* | submitselfserviceloginflow | post /self-service/login | Submit a Login Flow *PublicApi* | submitselfservicerecoveryflow | post /self-service/recovery | Complete Recovery Flow *PublicApi* | submitselfservicerecoveryflowwithlinkmethod | post /self-service/recovery/methods/link | Complete Recovery Flow with Link Method PublicApi | submitselfserviceregistrationflow | post /self-service/registration | Submit a Registration Flow PublicApi | submitselfservicesettingsflow | post /self-service/settings | Complete Settings Flow PublicApi | submitselfserviceverificationflow | post /self-service/verification/methods/link | Complete Verification Flow PublicApi | to_session | get /sessions/whoami | Check Who the Current HTTP Session Belongs To
To get access to the crate's generated documentation, use:
cargo doc --open
hi@ory.sh