#api-client #hydra #open-api

open-api-hydra

由Open API生成的Hydra客户端

1个稳定版本

1.0.0 2020年12月11日

#875认证

MIT/Apache

170KB
2K SLoC

Hydra的Rust API客户端

欢迎使用ORY Hydra HTTP API文档。您将在这里找到所有HTTP API的文档。

概述

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

  • API版本:最新版
  • 包版本:1.0.0
  • 构建包:org.openapitools.codegen.languages.RustClientCodegen

安装

将包放入您的项目文件夹中,并在Cargo.toml[dependencies]下添加以下内容

    openapi = { path = "./generated" }

API端点文档

所有URI都是相对于https://127.0.0.1

方法 HTTP请求 描述
AdminApi accept_consent_request put /oauth2/auth/requests/consent/accept 接受同意请求
AdminApi accept_login_request put /oauth2/auth/requests/login/accept 接受登录请求
AdminApi accept_logout_request put /oauth2/auth/requests/logout/accept 接受注销请求
AdminApi create_json_web_key_set post /keys/{set} 生成新的JSON Web密钥
AdminApi create_o_auth2_client post /clients 创建OAuth 2.0客户端
AdminApi delete_json_web_key delete /keys/{set}/{kid} 删除JSON Web密钥
AdminApi delete_json_web_key_set delete /keys/{set} 删除JSON Web密钥集
AdminApi delete_o_auth2_client delete /clients/{id} 删除OAuth 2.0客户端
AdminApi flush_inactive_o_auth2_tokens post /oauth2/flush 刷新过期的OAuth2访问令牌
AdminApi get_consent_request get /oauth2/auth/requests/consent 获取同意请求信息
AdminApi get_json_web_key get /keys/{set}/{kid} 获取JSON Web密钥
AdminApi get_json_web_key_set get /keys/{set} 检索JSON Web密钥集
AdminApi get_login_request get /oauth2/auth/requests/login 获取登录请求
AdminApi get_logout_request get /oauth2/auth/requests/logout 获取注销请求
AdminApi get_o_auth2_client get /clients/{id} 获取OAuth 2.0客户端。
AdminApi get_version get /version 获取服务版本
AdminApi introspect_o_auth2_token post /oauth2/introspect 审查OAuth2令牌
AdminApi is_instance_alive get /health/alive 检查存活状态
AdminApi list_o_auth2_clients get /clients 列出 OAuth 2.0 客户端
AdminApi list_subject_consent_sessions get /oauth2/auth/sessions/consent 列出主题的所有同意会话
AdminApi prometheus get /metrics/prometheus 从 Hydra 服务获取快照指标。如果您使用 k8s,可以像这样添加部署的注解
AdminApi reject_consent_request put /oauth2/auth/requests/consent/reject 拒绝同意请求
AdminApi reject_login_request put /oauth2/auth/requests/login/reject 拒绝登录请求
AdminApi reject_logout_request put /oauth2/auth/requests/logout/reject 拒绝注销请求
AdminApi revoke_authentication_session delete /oauth2/auth/sessions/login 使特定用户的全部登录会话无效,使主题的认证会话无效
AdminApi revoke_consent_sessions delete /oauth2/auth/sessions/consent 撤销特定 OAuth 2.0 客户端的主题同意会话
AdminApi update_json_web_key put /keys/{set}/{kid} 更新 JSON Web Key
AdminApi update_json_web_key_set put /keys/{set} 更新 JSON Web Key Set
AdminApi update_o_auth2_client put /clients/{id} 更新 OAuth 2.0 客户端
PublicApi disconnect_user get /oauth2/sessions/logout 启用 OpenID Connect 前后通道的注销
PublicApi discover_open_id_configuration get /.well-known/openid-configuration OpenID Connect 发现
PublicApi is_instance_ready get /health/ready 检查就绪状态
PublicApi oauth2_token post /oauth2/token OAuth 2.0 令牌端点
PublicApi oauth_auth get /oauth2/auth OAuth 2.0 授权端点
PublicApi revoke_o_auth2_token post /oauth2/revoke 撤销 OAuth2 令牌
PublicApi userinfo get /userinfo OpenID Connect Userinfo
PublicApi well_known get /.well-known/jwks.json JSON Web Keys 发现

模型文档

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

cargo doc --open

作者

依赖关系

~3–7.5MB
~171K SLoC