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.
- API version: v0.6.0-alpha.16
- Package version: v0.6.0-alpha.16
- Build package: org.openapitools.codegen.languages.RustClientCodegen
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 https://demo.tenants.oryapis.com/api/kratos/public
Class | Method | HTTP request | Description |
---|---|---|---|
AdminApi | create_identity | post /identities | Create an Identity |
AdminApi | create_recovery_link | post /recovery/link | Create a Recovery Link |
AdminApi | delete_identity | delete /identities/{id} | Delete an Identity |
AdminApi | get_identity | get /identities/{id} | Get an Identity |
AdminApi | get_schema | get /schemas/{id} | |
AdminApi | get_self_service_error | get /self-service/errors | Get User-Facing Self-Service Errors |
AdminApi | get_self_service_login_flow | get /self-service/login/flows | Get Login Flow |
AdminApi | get_self_service_recovery_flow | get /self-service/recovery/flows | Get information about a recovery flow |
AdminApi | get_self_service_registration_flow | get /self-service/registration/flows | Get Registration Flow |
AdminApi | get_self_service_settings_flow | get /self-service/settings/flows | Get Settings Flow |
AdminApi | get_self_service_verification_flow | get /self-service/verification/flows | Get Verification Flow |
AdminApi | get_version | get /version | Return Running Software Version. |
AdminApi | is_alive | get /health/alive | Check HTTP Server Status |
AdminApi | is_ready | get /health/ready | Check HTTP Server and Database Status |
AdminApi | list_identities | 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 | update_identity | put /identities/{id} | Update an Identity |
PublicApi | get_schema | get /schemas/{id} | |
PublicApi | get_self_service_error | get /self-service/errors | Get User-Facing Self-Service Errors |
PublicApi | get_self_service_login_flow | get /self-service/login/flows | Get Login Flow |
PublicApi | get_self_service_recovery_flow | get /self-service/recovery/flows | Get information about a recovery flow |
PublicApi | get_self_service_registration_flow | get /self-service/registration/flows | Get Registration Flow |
PublicApi | get_self_service_settings_flow | get /self-service/settings/flows | Get Settings Flow |
PublicApi | get_self_service_verification_flow | get /self-service/verification/flows | Get Verification Flow |
PublicApi | initialize_self_service_browser_logout_flow | get /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow |
PublicApi | initialize_self_service_login_via_api_flow | get /self-service/login/api | Initialize Login Flow for API clients |
PublicApi | initialize_self_service_login_via_browser_flow | get /self-service/login/browser | Initialize Login Flow for browsers |
PublicApi | initialize_self_service_recovery_via_api_flow | get /self-service/recovery/api | Initialize Recovery Flow for API Clients |
PublicApi | initialize_self_service_recovery_via_browser_flow | get /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients |
PublicApi | initialize_self_service_registration_via_api_flow | get /self-service/registration/api | Initialize Registration Flow for API clients |
PublicApi | initialize_self_service_registration_via_browser_flow | get /self-service/registration/browser | Initialize Registration Flow for browsers |
PublicApi | initialize_self_service_settings_via_api_flow | get /self-service/settings/api | Initialize Settings Flow for API Clients |
PublicApi | initialize_self_service_settings_via_browser_flow | get /self-service/settings/browser | Initialize Settings Flow for Browsers |
PublicApi | initialize_self_service_verification_via_api_flow | get /self-service/verification/api | Initialize Verification Flow for API Clients |
PublicApi | initialize_self_service_verification_via_browser_flow | get /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
PublicApi | revoke_session | delete /sessions | Initialize Logout Flow for API Clients - Revoke a Session |
PublicApi | submit_self_service_login_flow | post /self-service/login | Submit a Login Flow |
PublicApi | submit_self_service_recovery_flow | post /self-service/recovery | Complete Recovery Flow |
PublicApi | submit_self_service_recovery_flow_with_link_method | post /self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
PublicApi | submit_self_service_registration_flow | post /self-service/registration | Submit a Registration Flow |
PublicApi | submit_self_service_settings_flow | post /self-service/settings | Complete Settings Flow |
PublicApi | submit_self_service_verification_flow | post /self-service/verification/methods/link | Complete Verification Flow |
PublicApi | whoami | get /sessions/whoami | Check Who the Current HTTP Session Belongs To |
Documentation For Models
- AuthenticateOkBody
- ContainerChangeResponseItem
- ContainerCreateCreatedBody
- ContainerTopOkBody
- ContainerUpdateOkBody
- ContainerWaitOkBody
- ContainerWaitOkBodyError
- CreateIdentity
- CreateRecoveryLink
- ErrorContainer
- ErrorResponse
- GenericError
- GenericErrorPayload
- GraphDriverData
- HealthNotReadyStatus
- HealthStatus
- IdResponse
- Identity
- IdentityCredentials
- ImageDeleteResponseItem
- ImageSummary
- InlineResponse200
- InlineResponse2001
- InlineResponse503
- LoginFlow
- LoginViaApiResponse
- Meta
- Plugin
- PluginConfig
- PluginConfigArgs
- PluginConfigInterface
- PluginConfigLinux
- PluginConfigNetwork
- PluginConfigRootfs
- PluginConfigUser
- PluginDevice
- PluginEnv
- PluginInterfaceType
- PluginMount
- PluginSettings
- Port
- RecoveryAddress
- RecoveryFlow
- RecoveryLink
- RegistrationFlow
- RegistrationViaApiResponse
- RevokeSession
- ServiceUpdateResponse
- Session
- SettingsFlow
- SettingsProfileFormConfig
- SettingsViaApiResponse
- SubmitSelfServiceBrowserSettingsOidcFlowPayload
- SubmitSelfServiceLoginFlow
- SubmitSelfServiceLoginFlowWithPasswordMethod
- SubmitSelfServiceRecoveryFlowWithLinkMethod
- SubmitSelfServiceRegistrationFlow
- SubmitSelfServiceRegistrationFlowWithPasswordMethod
- SubmitSelfServiceSettingsFlow
- SubmitSelfServiceSettingsFlowWithPasswordMethod
- SubmitSelfServiceSettingsFlowWithProfileMethod
- SubmitSelfServiceVerificationFlowWithLinkMethod
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeInputAttributesValue
- UiNodeTextAttributes
- UiText
- UpdateIdentity
- VerifiableAddress
- VerificationFlow
- Version
- Volume
- VolumeUsageData
To get access to the crate's generated documentation, use:
cargo doc --open