CN - 简体中文
联 系 我 们
售前咨询
产品、解决方案咨询
售后咨询
微信关注：星环科技服务号
更多联系方式 >
大数据安全管理软件
3.2.6
大数据安全管理软件
3.2.6
本页导航
5 Guardian Rest API
更新时间：7/24/2024, 9:27:16 AM

Guardian开放了Rest API供第三方应用使用Guardian用户进行认证和授权的整合，并提供Swagger-UI方便查阅和测试使用API。本节将介绍如何在Swagger-UI查看和测试API，各API的完整信息都可在Swagger上获得。

  • 通过 https://<guardian-server-ip/hostname>:<port>/swagger-ui.html 访问api的swagger界面：

    swagger ui

    在Swagger界面上可以看到Guardian Server提供的所有API，主要包括以下模块：

    • perms：权限管理相关的API，例如查找、授予、查看权限等。

    • users：用户管理相关的API，例如新建、删除、查看所有用户等。

    • quotas：配额管理相关的API，例如添加、删除、查找配额等。

    • roles：角色管理相关的API，例如添加、删除、分配角色等。

    • resources：资源管理相关的API，例如刷新YARN队列、获取所有的资源列表等。

    • admin：Guardian管理相关的API，例如编辑密码策略、系统角色分配等。

    • login：认证登录相关的API，包括认证、登录和登出。

    • groups：用户组管理相关的API，包括新建/删除用户组、将用户/子组加入用户组等。

  • 下面以login模块中的"login" API 为例，点击“Model|Example Value”可以查看所使用的Model和Model示例。

    swagger login api intro

  • 点击Parameters中的Try it out，参数示例将自动地拷贝到Example Value中，您只需要改动具体的值即可。

    swagger login api parameters

  • 按输入参数格式填写您的Guardian用户名和密码后(isSystem参数设置成false)，点击 swagger execute可以直接对API进行调用。返回结果将按照“Responses”中的Model格式输出：

    swagger login api response

访问Guardian Server Swagger中暴露的绝大部份的API都必须先通过Guardian Federation或者CAS登录Guardian Server，或者调用上述login API通过认证后，才可访问。