Rust API client for ory-client
Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
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.0.1-alpha.16
- Package version: v0.0.1-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://playground.projects.oryapis.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| MetadataApi | get_version | get /api/kratos/public/version | Return Running Software Version. |
| MetadataApi | is_alive | get /api/kratos/public/health/alive | Check HTTP Server Status |
| MetadataApi | is_ready | get /api/kratos/public/health/ready | Check HTTP Server and Database Status |
| MetadataApi | prometheus | get /api/kratos/public/metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
| V0alpha1Api | admin_create_identity | post /api/kratos/admin/identities | Create an Identity |
| V0alpha1Api | admin_create_self_service_recovery_link | post /api/kratos/admin/recovery/link | Create a Recovery Link |
| V0alpha1Api | admin_delete_identity | delete /api/kratos/admin/identities/{id} | Delete an Identity |
| V0alpha1Api | admin_get_identity | get /api/kratos/admin/identities/{id} | Get an Identity |
| V0alpha1Api | admin_list_identities | get /api/kratos/admin/identities | List Identities |
| V0alpha1Api | admin_update_identity | put /api/kratos/admin/identities/{id} | Update an Identity |
| V0alpha1Api | create_self_service_logout_flow_url_for_browsers | get /api/kratos/public/self-service/logout/browser | Create a Logout URL for Browsers |
| V0alpha1Api | get_json_schema | get /api/kratos/public/schemas/{id} | |
| V0alpha1Api | get_self_service_error | get /api/kratos/public/self-service/errors | Get Self-Service Errors |
| V0alpha1Api | get_self_service_login_flow | get /api/kratos/public/self-service/login/flows | Get Login Flow |
| V0alpha1Api | get_self_service_recovery_flow | get /api/kratos/public/self-service/recovery/flows | Get Recovery Flow |
| V0alpha1Api | get_self_service_registration_flow | get /api/kratos/public/self-service/registration/flows | Get Registration Flow |
| V0alpha1Api | get_self_service_settings_flow | get /api/kratos/public/self-service/settings/flows | Get Settings Flow |
| V0alpha1Api | get_self_service_verification_flow | get /api/kratos/public/self-service/verification/flows | Get Verification Flow |
| V0alpha1Api | initialize_self_service_login_flow_for_browsers | get /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers |
| V0alpha1Api | initialize_self_service_login_flow_without_browser | get /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
| V0alpha1Api | initialize_self_service_recovery_flow_for_browsers | get /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browsers |
| V0alpha1Api | initialize_self_service_recovery_flow_without_browser | get /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... |
| V0alpha1Api | initialize_self_service_registration_flow_for_browsers | get /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers |
| V0alpha1Api | initialize_self_service_registration_flow_without_browser | get /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... |
| V0alpha1Api | initialize_self_service_settings_flow_for_browsers | get /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers |
| V0alpha1Api | initialize_self_service_settings_flow_without_browser | get /api/kratos/public/self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... |
| V0alpha1Api | initialize_self_service_verification_flow_for_browsers | get /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients |
| V0alpha1Api | initialize_self_service_verification_flow_without_browser | get /api/kratos/public/self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
| V0alpha1Api | submit_self_service_login_flow | post /api/kratos/public/self-service/login | Submit a Login Flow |
| V0alpha1Api | submit_self_service_logout_flow | get /api/kratos/public/self-service/logout | Complete Self-Service Logout |
| V0alpha1Api | submit_self_service_logout_flow_without_browser | delete /api/kratos/public/self-service/logout/api | Perform Logout for APIs, Services, Apps, ... |
| V0alpha1Api | submit_self_service_recovery_flow | post /api/kratos/public/self-service/recovery | Complete Recovery Flow |
| V0alpha1Api | submit_self_service_registration_flow | post /api/kratos/public/self-service/registration | Submit a Registration Flow |
| V0alpha1Api | submit_self_service_settings_flow | post /api/kratos/public/self-service/settings | Complete Settings Flow |
| V0alpha1Api | submit_self_service_verification_flow | post /api/kratos/public/self-service/verification | Complete Verification Flow |
| V0alpha1Api | to_session | get /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To |
Documentation For Models
- AdminCreateIdentityBody
- AdminCreateSelfServiceRecoveryLinkBody
- AdminUpdateIdentityBody
- AuthenticateOkBody
- ContainerChangeResponseItem
- ContainerCreateCreatedBody
- ContainerTopOkBody
- ContainerUpdateOkBody
- ContainerWaitOkBody
- ContainerWaitOkBodyError
- ErrorResponse
- GenericError
- GraphDriverData
- HealthNotReadyStatus
- HealthStatus
- IdResponse
- Identity
- IdentityCredentials
- IdentityState
- ImageDeleteResponseItem
- ImageSummary
- InlineResponse200
- InlineResponse2001
- InlineResponse503
- JsonError
- Meta
- Plugin
- PluginConfig
- PluginConfigArgs
- PluginConfigInterface
- PluginConfigLinux
- PluginConfigNetwork
- PluginConfigRootfs
- PluginConfigUser
- PluginDevice
- PluginEnv
- PluginInterfaceType
- PluginMount
- PluginSettings
- Port
- RecoveryAddress
- SelfServiceError
- SelfServiceLoginFlow
- SelfServiceLogoutUrl
- SelfServiceRecoveryFlow
- SelfServiceRecoveryFlowState
- SelfServiceRecoveryLink
- SelfServiceRegistrationFlow
- SelfServiceSettingsFlow
- SelfServiceSettingsFlowState
- SelfServiceVerificationFlow
- SelfServiceVerificationFlowState
- ServiceUpdateResponse
- Session
- SettingsProfileFormConfig
- SubmitSelfServiceLoginFlowBody
- SubmitSelfServiceLoginFlowWithOidcMethodBody
- SubmitSelfServiceLoginFlowWithPasswordMethodBody
- SubmitSelfServiceLogoutFlowWithoutBrowserBody
- SubmitSelfServiceRecoveryFlowBody
- SubmitSelfServiceRecoveryFlowWithLinkMethodBody
- SubmitSelfServiceRegistrationFlowBody
- SubmitSelfServiceRegistrationFlowWithOidcMethodBody
- SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
- SubmitSelfServiceSettingsFlowBody
- SubmitSelfServiceSettingsFlowWithOidcMethodBody
- SubmitSelfServiceSettingsFlowWithPasswordMethodBody
- SubmitSelfServiceSettingsFlowWithProfileMethodBody
- SubmitSelfServiceVerificationFlowBody
- SubmitSelfServiceVerificationFlowWithLinkMethodBody
- SuccessfulSelfServiceLoginWithoutBrowser
- SuccessfulSelfServiceRegistrationWithoutBrowser
- SuccessfulSelfServiceSettingsWithoutBrowser
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeTextAttributes
- UiText
- VerifiableIdentityAddress
- Version
- Volume
- VolumeUsageData
To get access to the crate's generated documentation, use:
cargo doc --open