Lib.rs

› 认证
#access-token #client-token #api-client #api-token #ory #endpoint

ory-client

Ory 的 SDK 客户端

由 OpenAPI Generator 团队和贡献者创建。 所有权归 hackerman。

253 个版本 (80 个稳定版本)

1.9.0 2024 年 3 月 18 日
1.5.2 2024 年 1 月 29 日
1.4.7 2023 年 12 月 20 日
1.4.3 2023 年 11 月 27 日
0.0.1-alpha.162021 年 7 月 21 日

#49 在 认证

Download history 120/week @ 2024-04-05 131/week @ 2024-04-12 258/week @ 2024-04-19 16/week @ 2024-04-26 32/week @ 2024-05-03 91/week @ 2024-05-10 176/week @ 2024-05-17 227/week @ 2024-05-24 132/week @ 2024-05-31 159/week @ 2024-06-07 111/week @ 2024-06-14 98/week @ 2024-06-21 200/week @ 2024-06-28 230/week @ 2024-07-05 112/week @ 2024-07-12 243/week @ 2024-07-19

每月 796 次下载

Apache-2.0

1MB
13K SLoC

Rust API 客户端 for ory-client

所有公共和行政 Ory API 的文档。行政 API 只能用有效的个人访问令牌访问。公共 API 主要用于浏览器。

概述

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

  • API 版本：v1.9.0
  • 包版本：v1.9.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在名为 ory-client 的目录下，并将以下内容添加到 Cargo.toml 中的 [dependencies]

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

API 端点文档

所有 URI 都相对于 https://playground.projects.oryapis.com

类 方法 HTTP 请求 描述
CourierApi get_courier_message GET /admin/courier/messages/{id} 获取消息
CourierApi list_courier_messages GET /admin/courier/messages 列出消息
EventsApi create_event_stream POST /projects/{project_id}/eventstreams 为您的项目创建事件流。
EventsApi delete_event_stream DELETE /projects/{project_id}/eventstreams/{event_stream_id} 从项目中删除事件流
EventsApi list_event_streams GET /projects/{project_id}/eventstreams 列出项目中所有事件流。此端点未分页。
EventsApi set_event_stream PUT /projects/{project_id}/eventstreams/{event_stream_id} 更新项目中的事件流。
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} 更新身份
JwkApi create_json_web_key_set POST /admin/keys/{set} 创建JSON Web密钥
JwkApi delete_json_web_key DELETE /admin/keys/{set}/{kid} 删除JSON Web密钥
JwkApi delete_json_web_key_set DELETE /admin/keys/{set} 删除JSON Web密钥集
JwkApi get_json_web_key GET /admin/keys/{set}/{kid} 获取JSON Web密钥
JwkApi get_json_web_key_set GET /admin/keys/{set} 检索JSON Web密钥集
JwkApi set_json_web_key PUT /admin/keys/{set}/{kid} 设置JSON Web密钥
JwkApi set_json_web_key_set PUT /admin/keys/{set} 更新JSON Web密钥集
MetadataApi get_version GET /version 返回运行软件版本。
MetadataApi is_alive GET /health/alive 检查HTTP服务器状态
MetadataApi is_ready GET /health/ready 检查HTTP服务器和数据库状态
OAuth2Api accept_o_auth2_consent_request PUT /admin/oauth2/auth/requests/consent/accept 接受OAuth 2.0同意请求
OAuth2Api accept_o_auth2_login_request PUT /admin/oauth2/auth/requests/login/accept 接受OAuth 2.0登录请求
OAuth2Api accept_o_auth2_logout_request PUT /admin/oauth2/auth/requests/logout/accept 接受OAuth 2.0会话注销请求
OAuth2Api create_o_auth2_client POST /admin/clients 创建OAuth 2.0客户端
OAuth2Api delete_o_auth2_client DELETE /admin/clients/{id} 删除OAuth 2.0客户端
OAuth2Api delete_o_auth2_token DELETE /admin/oauth2/tokens 从特定OAuth 2.0客户端删除访问令牌
OAuth2Api delete_trusted_o_auth2_jwt_grant_issuer DELETE /admin/trust/grants/jwt-bearer/issuers/{id} 删除受信任的OAuth2 JWT授权类型发行者
OAuth2Api get_o_auth2_client GET /admin/clients/{id} 获取OAuth 2.0客户端
OAuth2Api get_o_auth2_consent_request GET /admin/oauth2/auth/requests/consent 获取OAuth 2.0同意请求
OAuth2Api get_o_auth2_login_request GET /admin/oauth2/auth/requests/login 获取OAuth 2.0登录请求
OAuth2Api get_o_auth2_logout_request GET /admin/oauth2/auth/requests/logout 获取OAuth 2.0会话注销请求
OAuth2Api get_trusted_o_auth2_jwt_grant_issuer GET /admin/trust/grants/jwt-bearer/issuers/{id} 获取受信任的OAuth2 JWT授权类型发行者
OAuth2Api introspect_o_auth2_token POST /admin/oauth2/introspect 检查OAuth2访问和刷新令牌
OAuth2Api list_o_auth2_clients GET /admin/clients 列出OAuth 2.0客户端
OAuth2Api list_o_auth2_consent_sessions GET /admin/oauth2/auth/sessions/consent 列出主题的OAuth 2.0同意会话
OAuth2Api list_trusted_o_auth2_jwt_grant_issuers GET /admin/trust/grants/jwt-bearer/issuers 列出受信任的OAuth2 JWT授权类型发行者
OAuth2Api o_auth2_authorize GET /oauth2/auth OAuth 2.0授权端点
OAuth2Api oauth2_token_exchange POST /oauth2/token OAuth 2.0令牌端点
OAuth2Api patch_o_auth2_client PATCH /admin/clients/{id} 修补OAuth 2.0客户端
OAuth2Api reject_o_auth2_consent_request PUT /admin/oauth2/auth/requests/consent/reject 拒绝OAuth 2.0同意请求
OAuth2Api reject_o_auth2_login_request PUT /admin/oauth2/auth/requests/login/reject 拒绝OAuth 2.0登录请求
OAuth2Api reject_o_auth2_logout_request PUT /admin/oauth2/auth/requests/logout/reject 拒绝OAuth 2.0会话注销请求
OAuth2Api revoke_o_auth2_consent_sessions DELETE /admin/oauth2/auth/sessions/consent 撤销主题的OAuth 2.0同意会话
OAuth2Api revoke_o_auth2_login_sessions DELETE /admin/oauth2/auth/sessions/login 通过主题或会话ID撤销OAuth 2.0登录会话
OAuth2Api revoke_o_auth2_token POST /oauth2/revoke 撤销OAuth 2.0访问或刷新令牌
OAuth2Api set_o_auth2_client PUT /admin/clients/{id} 设置OAuth 2.0客户端
OAuth2Api set_o_auth2_client_lifespans PUT /admin/clients/{id}/lifespans 设置OAuth2客户端令牌有效期
OAuth2Api trust_o_auth2_jwt_grant_issuer POST /admin/trust/grants/jwt-bearer/issuers 信任OAuth2 JWT Bearer授权类型发行者
OidcApi create_oidc_dynamic_client POST /oauth2/register 使用OpenID动态客户端注册注册OAuth2客户端
OidcApi create_verifiable_credential POST /credentials 颁发可验证凭证
OidcApi delete_oidc_dynamic_client DELETE /oauth2/register/{id} 使用OpenID动态客户端注册管理协议删除OAuth 2.0客户端
OidcApi discover_oidc_configuration GET /.well-known/openid-configuration OpenID Connect发现
OidcApi get_oidc_dynamic_client GET /oauth2/register/{id} 使用OpenID动态客户端注册获取OAuth2客户端
OidcApi get_oidc_user_info GET /userinfo OpenID Connect用户信息
OidcApi revoke_oidc_session GET /oauth2/sessions/logout 启用前后端通道的OpenID Connect会话注销
OidcApi set_oidc_dynamic_client PUT /oauth2/register/{id} 使用OpenID动态客户端注册设置OAuth2客户端
PermissionApi check_permission GET /relation-tuples/check/openapi 检查权限
PermissionApi check_permission_or_error GET /relation-tuples/check 检查权限
PermissionApi expand_permissions GET /relation-tuples/expand 将关系扩展为权限。
PermissionApi post_check_permission POST /relation-tuples/check/openapi 检查权限
PermissionApi post_check_permission_or_error POST /relation-tuples/check 检查权限
ProjectApi create_organization POST /projects/{project_id}/organizations
ProjectApi 创建项目 POST /projects 创建一个项目
ProjectApi create_project_api_key POST /projects/{project}/tokens 创建项目API令牌
ProjectApi delete_organization DELETE /projects/{project_id}/organizations/{organization_id} 删除一个项目的B2B SSO组织。
ProjectApi delete_project_api_key DELETE /projects/{project}/tokens/{token_id} 删除项目API令牌
ProjectApi get_active_project_in_console GET /console/active/project 返回在Ory Network控制台选择的Ory Network项目
ProjectApi get_organization GET /projects/{project_id}/organizations/{organization_id} 根据ID返回项目的B2B SSO组织。
ProjectApi get_project GET /projects/{project_id} 获取项目
ProjectApi get_project_members GET /projects/{project}/members 获取与此项目关联的所有成员
ProjectApi get_project_metrics GET /projects/{project_id}/metrics
ProjectApi list_organizations GET /projects/{project_id}/organizations
ProjectApi list_project_api_keys GET /projects/{project}/tokens 列出项目的API令牌
ProjectApi list_projects GET /projects 列出所有项目
ProjectApi patch_project PATCH /projects/{project_id} 修补Ory Network项目配置
ProjectApi purge_project DELETE /projects/{project_id} 不可恢复地清除项目
ProjectApi remove_project_member DELETE /projects/{project}/members/{member} 删除与此项目关联的成员
ProjectApi set_active_project_in_console PUT /console/active/project 在Ory Network控制台中设置Ory Network项目为活动状态
ProjectApi set_project PUT /projects/{project_id} 更新Ory Network项目配置
ProjectApi update_organization PUT /projects/{project_id}/organizations/{organization_id} 更新项目的B2B SSO组织。
RelationshipApi check_opl_syntax POST /opl/syntax/check 检查OPL文件的语法
RelationshipApi create_relationship PUT /admin/relation-tuples 创建关系
RelationshipApi delete_relationships DELETE /admin/relation-tuples 删除关系
RelationshipApi get_relationships GET /relation-tuples 查询关系
RelationshipApi list_relationship_namespaces GET /namespaces 查询命名空间
RelationshipApi patch_relationships 补丁 /admin/relation-tuples 修补多个关系
常用API 发现JSON Web密钥 GET /.well-known/jwks.json 发现已知JSON Web密钥

模型文档

要获取crate生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖

~4–16MB
~234K SLoC