1 个不稳定版本
0.0.1-alpha.1 | 2021 年 5 月 18 日 |
---|
#1824 in 网页编程
225KB
3K SLoC
Rust API 客户端用于 ory-client-client
所有公共和行政 Ory API 的文档。行政 API 只能通过有效的个人访问令牌访问。公共 API 主要用于浏览器中。
概述
此 API 客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec,您可以轻松生成 API 客户端。
- API 版本:v0.0.1-alpha.1
- 包版本:v0.0.1-alpha.1
- 构建包:org.openapitools.codegen.languages.RustClientCodegen
安装
将包放入您的项目文件夹中,并在 Cargo.toml
中的 [dependencies]
下添加以下内容
openapi = { path = "./generated" }
API 端点文档
所有 URI 都相对于 https://playground.projects.oryapis.com
类 | 方法 | HTTP 请求 | 描述 |
---|---|---|---|
DefaultApi | create_identity_admin | post /api/kratos/admin/identities | 创建一个身份 |
DefaultApi | create_recovery_link_admin | post /api/kratos/admin/recovery/link | 创建一个恢复链接 |
DefaultApi | delete_identity_admin | delete /api/kratos/admin/identities/{id} | 删除一个身份 |
DefaultApi | get_identity_admin | get /api/kratos/admin/identities/{id} | 获取一个身份 |
DefaultApi | get_schema | get /api/kratos/public/schemas/{id} | |
DefaultApi | get_schema_admin | get /api/kratos/admin/schemas/{id} | |
DefaultApi | get_self_service_error | get /api/kratos/public/self-service/errors | 获取用户界面自我服务错误 |
DefaultApi | get_self_service_error_admin | get /api/kratos/admin/self-service/errors | 获取用户界面自我服务错误 |
DefaultApi | get_self_service_login_flow | get /api/kratos/public/self-service/login/flows | 获取登录流程 |
DefaultApi | get_self_service_login_flow_admin | get /api/kratos/admin/self-service/login/flows | 获取登录流程 |
DefaultApi | get_self_service_recovery_flow | get /api/kratos/public/self-service/recovery/flows | 获取恢复流程的信息 |
DefaultApi | get_self_service_recovery_flow_admin | get /api/kratos/admin/self-service/recovery/flows | 获取恢复流程的信息 |
DefaultApi | get_self_service_registration_flow | get /api/kratos/public/self-service/registration/flows | 获取注册流程 |
DefaultApi | get_self_service_registration_flow_admin | get /api/kratos/admin/self-service/registration/flows | 获取注册流程 |
DefaultApi | get_self_service_settings_flow | get /api/kratos/public/self-service/settings/flows | 获取设置流程 |
DefaultApi | get_self_service_settings_flow_admin | get /api/kratos/admin/self-service/settings/flows | 获取设置流程 |
DefaultApi | get_self_service_verification_flow | get /api/kratos/public/self-service/verification/flows | 获取验证流程 |
DefaultApi | get_self_service_verification_flow_admin | get /api/kratos/admin/self-service/verification/flows | 获取验证流程 |
DefaultApi | get_version_admin | get /api/kratos/admin/version | 返回运行软件版本。 |
DefaultApi | initialize_self_service_browser_logout_flow | get /api/kratos/public/self-service/browser/flows/logout | 初始化基于浏览器的注销用户流程 |
DefaultApi | initialize_self_service_login_via_api_flow | get /api/kratos/public/self-service/login/api | 初始化API客户端的登录流程 |
DefaultApi | initialize_self_service_login_via_browser_flow | get /api/kratos/public/self-service/login/browser | 初始化浏览器的登录流程 |
DefaultApi | initialize_self_service_recovery_via_api_flow | get /api/kratos/public/self-service/recovery/api | 初始化API客户端的恢复流程 |
DefaultApi | initialize_self_service_recovery_via_browser_flow | get /api/kratos/public/self-service/recovery/browser | 初始化浏览器客户端的恢复流程 |
DefaultApi | initialize_self_service_registration | get /api/kratos/public/self-service/registration/api | 初始化API客户端的注册流程 |
DefaultApi | initialize_self_service_registration_for_browsers | get /api/kratos/public/self-service/registration/browser | 初始化浏览器的注册流程 |
DefaultApi | initialize_self_service_settings_via_api_flow | get /api/kratos/public/self-service/settings/api | 初始化API客户端的设置流程 |
DefaultApi | initialize_self_service_settings_via_browser_flow | get /api/kratos/public/self-service/settings/browser | 初始化浏览器的设置流程 |
DefaultApi | initialize_self_service_verification_via_api_flow | get /api/kratos/public/self-service/verification/api | 初始化API客户端的验证流程 |
DefaultApi | initialize_self_service_verification_via_browser_flow | get /api/kratos/public/self-service/verification/browser | 初始化浏览器客户端的验证流程 |
DefaultApi | is_alive_admin | get /api/kratos/admin/health/alive | 检查HTTP服务器状态 |
DefaultApi | is_ready_admin | get /api/kratos/admin/health/ready | 检查HTTP服务器和数据库状态 |
DefaultApi | list_identities_admin | get /api/kratos/admin/identities | 列出身份 |
DefaultApi | prometheus_admin | get /api/kratos/admin/metrics/prometheus | 从Hydra服务获取快照指标。如果你使用k8s,你可以这样给你的部署添加注解 |
DefaultApi | revoke_session | delete /api/kratos/public/sessions | 初始化API客户端的注销流程 - 撤销会话 |
DefaultApi | submit_self_service_login_flow | post /api/kratos/public/self-service/login | 提交登录流程 |
DefaultApi | submit_self_service_recovery_flow | post /api/kratos/public/self-service/recovery | 完成恢复流程 |
DefaultApi | submit_self_service_recovery_flow_with_link_method | post /api/kratos/public/self-service/recovery/methods/link | 使用链接方法完成恢复流程 |
DefaultApi | submit_self_service_registration_flow | post /api/kratos/public/self-service/registration | 提交注册流程 |
DefaultApi | submit_self_service_settings_flow | post /api/kratos/public/self-service/settings | 完成设置流程 |
DefaultApi | submit_self_service_verification_flow | post /api/kratos/public/self-service/verification/methods/link | 完成验证流程 |
DefaultApi | to_session | get /api/kratos/public/sessions/whoami | 检查当前HTTP会话属于谁 |
DefaultApi | update_identity_admin | put /api/kratos/admin/identities/{id} | 更新身份 |
模型文档
- AuthenticateOkBody
- ContainerChangeResponseItem
- ContainerCreateCreatedBody
- ContainerTopOkBody
- ContainerUpdateOkBody
- ContainerWaitOkBody
- ContainerWaitOkBodyError
- CreateIdentity
- CreateRecoveryLink
- ErrorContainer
- ErrorResponse
- GenericError
- GraphDriverData
- HealthNotReadyStatus
- HealthStatus
- IdResponse
- Identity
- IdentityCredentials
- ImageDeleteResponseItem
- ImageSummary
- InlineResponse200
- InlineResponse2001
- InlineResponse503
- JsonError
- LoginFlow
- LoginViaApiResponse
- Meta
- Plugin
- PluginConfig
- PluginConfigArgs
- PluginConfigInterface
- PluginConfigLinux
- PluginConfigNetwork
- PluginConfigRootfs
- 插件配置用户
- 插件设备
- 插件环境
- 插件接口类型
- 插件挂载
- 插件设置
- 端口
- 恢复地址
- 恢复流程
- 恢复链接
- 注册流程
- 通过API响应注册
- 撤销会话
- 服务更新响应
- 会话
- 设置流程
- 设置配置表单
- 通过API响应设置
- 提交自我服务浏览器设置OIDC流程有效载荷
- 提交自我服务登录流程
- 提交带密码方法的自我服务登录流程
- 提交带链接方法的自我服务恢复流程
- 提交自我服务注册流程
- 提交带密码方法的自我服务注册流程
- 提交自我服务设置流程
- 提交带密码方法的自我服务设置流程
- 提交带配置方法的自我服务设置流程
- 提交带链接方法的自我服务验证流程
- UI容器
- UI节点
- UI节点锚点属性
- UI节点属性
- UI节点图片属性
- UI节点输入属性
- UI节点输入属性值
- UI文本属性
- UI文本
- 更新身份
- 可验证身份地址
- 验证流程
- 版本
- 卷
- 卷使用数据
要获取crate生成的文档,请使用
cargo doc --open
作者
依赖项
~4-19MB
~249K SLoC