#api-client #identity #session #identity-management #ory #recovery #login

ory-kratos-client

Ory Kratos的SDK客户端

35个版本 (2个稳定版本)

1.1.0 2024年2月20日
1.0.0 2023年8月31日
0.13.1 2023年4月29日
0.11.1 2023年1月14日
0.7.1-alpha.12021年7月22日

#109 in 身份验证

Download history 28/week @ 2024-03-14 6/week @ 2024-03-21 45/week @ 2024-03-28 32/week @ 2024-04-04 23/week @ 2024-04-11 14/week @ 2024-04-18 25/week @ 2024-04-25 21/week @ 2024-05-02 20/week @ 2024-05-09 20/week @ 2024-05-16 151/week @ 2024-05-23 56/week @ 2024-05-30 96/week @ 2024-06-06 84/week @ 2024-06-13 68/week @ 2024-06-20 622/week @ 2024-06-27

每月872次下载

Apache-2.0

435KB
5.5K SLoC

Rust API客户端用于ory-kratos-client

这是Ory身份的API规范,具有注册、登录、恢复、账户验证、个人资料设置、密码重置、身份管理、会话管理、电子邮件和短信投递等功能。

概述

此API客户端由OpenAPI Generator项目生成。通过使用来自远程服务器的openapi-spec,您可以轻松生成API客户端。

  • API版本:v1.1.0
  • 包版本:v1.1.0
  • 构建包:org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在项目文件夹下的ory-kratos-client目录中,并在Cargo.toml下的[dependencies]中添加以下内容

ory-kratos-client = { path = "./ory-kratos-client" }

API端点文档

所有URI均相对于https://127.0.0.1

方法 HTTP请求 描述
CourierApi get_courier_message GET /admin/courier/messages/{id} 获取消息
CourierApi list_courier_messages GET /admin/courier/messages 列出消息
FrontendApi create_browser_login_flow GET /self-service/login/browser 为浏览器创建登录流程
FrontendApi create_browser_logout_flow GET /self-service/logout/browser 为浏览器创建注销URL
FrontendApi create_browser_recovery_flow GET /self-service/recovery/browser 为浏览器创建恢复流程
FrontendApi create_browser_registration_flow GET /self-service/registration/browser 为浏览器创建注册流程
FrontendApi create_browser_settings_flow GET /self-service/settings/browser 为浏览器创建设置流程
FrontendApi create_browser_verification_flow GET /self-service/verification/browser 为浏览器客户端创建验证流程
FrontendApi create_native_login_flow GET /self-service/login/api 为原生应用创建登录流程
FrontendApi create_native_recovery_flow GET /self-service/recovery/api 为原生应用创建恢复流程
FrontendApi create_native_registration_flow GET /self-service/registration/api 为原生应用创建注册流程
FrontendApi create_native_settings_flow GET /self-service/settings/api 为原生应用创建设置流程
FrontendApi create_native_verification_flow GET /self-service/verification/api 为原生应用创建验证流程
FrontendApi disable_my_other_sessions DELETE /sessions 禁用我的其他会话
FrontendApi disable_my_session DELETE /sessions/{id} 禁用我的一个会话
FrontendApi exchange_session_token GET /sessions/token-exchange 交换会话令牌
FrontendApi get_flow_error GET /self-service/errors 获取用户流程错误
FrontendApi get_login_flow GET /self-service/login/flows 获取登录流程
FrontendApi get_recovery_flow GET /self-service/recovery/flows 获取恢复流程
FrontendApi get_registration_flow GET /self-service/registration/flows 获取注册流程
FrontendApi get_settings_flow GET /self-service/settings/flows 获取设置流程
FrontendApi get_verification_flow GET /self-service/verification/flows 获取验证流程
FrontendApi get_web_authn_java_script GET /.well-known/ory/webauthn.js 获取 WebAuthn JavaScript
FrontendApi list_my_sessions GET /sessions 获取我的活动会话
FrontendApi perform_native_logout DELETE /self-service/logout/api 为原生应用执行注销
FrontendApi to_session GET /sessions/whoami 检查当前 HTTP 会话属于谁
FrontendApi update_login_flow POST /self-service/login 提交登录流程
FrontendApi update_logout_flow GET /self-service/logout 更新注销流程
FrontendApi update_recovery_flow POST /self-service/recovery 更新恢复流程
FrontendApi update_registration_flow POST /self-service/registration 更新注册流程
FrontendApi update_settings_flow POST /self-service/settings 完成设置流程
FrontendApi update_verification_flow POST /self-service/verification 完成验证流程
IdentityApi batch_patch_identities PATCH /admin/identities 创建和删除多个身份
IdentityApi create_identity POST /admin/identities 创建一个身份
IdentityApi create_recovery_code_for_identity POST /admin/recovery/code 创建一个恢复码
IdentityApi create_recovery_link_for_identity POST /admin/recovery/link 创建一个恢复链接
IdentityApi delete_identity DELETE /admin/identities/{id} 删除一个身份
IdentityApi delete_identity_credentials DELETE /admin/identities/{id}/credentials/{type} 删除特定身份的凭证
IdentityApi delete_identity_sessions DELETE /admin/identities/{id}/sessions 删除并使一个身份的会话无效
IdentityApi disable_session DELETE /admin/sessions/{id} 停用会话
IdentityApi extend_session PATCH /admin/sessions/{id}/extend 延长会话
IdentityApi get_identity GET /admin/identities/{id} 获取一个身份
IdentityApi get_identity_schema GET /schemas/{id} 获取身份 JSON 模式
IdentityApi get_session GET /admin/sessions/{id} 获取会话
IdentityApi list_identities GET /admin/identities 列出身份
IdentityApi list_identity_schemas GET /schemas 获取所有身份模式
IdentityApi list_identity_sessions GET /admin/identities/{id}/sessions 列出一个身份的会话
IdentityApi list_sessions GET /admin/sessions 列出所有会话
IdentityApi patch_identity PATCH /admin/identities/{id} 修补一个身份
IdentityApi update_identity PUT /admin/identities/{id} 更新一个身份
MetadataApi get_version GET /version 返回运行软件版本。
MetadataApi is_alive GET /health/alive 检查HTTP服务器状态
MetadataApi is_ready GET /health/ready 检查HTTP服务器和数据库状态

模型文档

要获取生成文档的访问权限,请使用

cargo doc --open

作者

[email protected]

依赖关系

~4–18MB
~248K SLoC