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 ------------ | ------------- | ------------- | ------------- 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 *MetadataApi* | prometheus | get /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: *V0alpha1Api* | admincreateidentity | post /identities | Create an Identity *V0alpha1Api* | admincreateselfservicerecoverylink | post /recovery/link | Create a Recovery Link V0alpha1Api | admindeleteidentity | delete /identities/{id} | Delete an Identity V0alpha1Api | admingetidentity | get /identities/{id} | Get an Identity V0alpha1Api | adminlistidentities | get /identities | List Identities V0alpha1Api | adminupdateidentity | put /identities/{id} | Update an Identity V0alpha1Api | createselfservicelogoutflowurlforbrowsers | get /self-service/logout/browser | Create a Logout URL for Browsers *V0alpha1Api* | getjsonschema | get /schemas/{id} | *V0alpha1Api* | getselfserviceerror | get /self-service/errors | Get Self-Service Errors V0alpha1Api | getselfserviceloginflow | get /self-service/login/flows | Get Login Flow V0alpha1Api | getselfservicerecoveryflow | get /self-service/recovery/flows | Get Recovery Flow V0alpha1Api | getselfserviceregistrationflow | get /self-service/registration/flows | Get Registration Flow V0alpha1Api | getselfservicesettingsflow | get /self-service/settings/flows | Get Settings Flow V0alpha1Api | getselfserviceverificationflow | get /self-service/verification/flows | Get Verification Flow V0alpha1Api | initializeselfserviceloginflowforbrowsers | get /self-service/login/browser | Initialize Login Flow for Browsers V0alpha1Api | initializeselfserviceloginflowwithoutbrowser | get /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... V0alpha1Api | initializeselfservicerecoveryflowforbrowsers | get /self-service/recovery/browser | Initialize Recovery Flow for Browsers V0alpha1Api | initializeselfservicerecoveryflowwithoutbrowser | get /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... V0alpha1Api | initializeselfserviceregistrationflowforbrowsers | get /self-service/registration/browser | Initialize Registration Flow for Browsers V0alpha1Api | initializeselfserviceregistrationflowwithoutbrowser | get /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... V0alpha1Api | initializeselfservicesettingsflowforbrowsers | get /self-service/settings/browser | Initialize Settings Flow for Browsers V0alpha1Api | initializeselfservicesettingsflowwithoutbrowser | get /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... V0alpha1Api | initializeselfserviceverificationflowforbrowsers | get /self-service/verification/browser | Initialize Verification Flow for Browser Clients V0alpha1Api | initializeselfserviceverificationflowwithoutbrowser | get /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... V0alpha1Api | submitselfserviceloginflow | post /self-service/login | Submit a Login Flow V0alpha1Api | submitselfservicelogoutflow | get /self-service/logout | Complete Self-Service Logout V0alpha1Api | submitselfservicelogoutflowwithoutbrowser | delete /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... V0alpha1Api | submitselfservicerecoveryflow | post /self-service/recovery | Complete Recovery Flow V0alpha1Api | submitselfserviceregistrationflow | post /self-service/registration | Submit a Registration Flow V0alpha1Api | submitselfservicesettingsflow | post /self-service/settings | Complete Settings Flow V0alpha1Api | submitselfserviceverificationflow | post /self-service/verification | Complete Verification Flow V0alpha1Api | 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