Apache Ranger Public REST APIs-User-Group使用Postman测试

用户管理API(User APIs)

创建用户

POST /xusers/users
POST /xusers/secure/users

API Name: POST Service
Request Type: POST
Request URL: 
	http://host.domain:6080/service/xusers/users/
	http://host.domain:6080/service/xusers/secure/users/
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
{
	"name": "zhangsan",
	"firstName": "zhangsan",
	"lastName": "zhangsan",
	"loginId": "zhangsan",
	"emailAddress": null,
	"description": "zhangsan - add from postman",
	"password": "123456",	# 移除密码字段,用户将变成外部用户
	"groupIdList": [],
	"status": 1,
	"isVisible": 1,
	"userRoleList": [   # "ROLE_SYS_ADMIN":Role:Admin 或 "ROLE_USER":Role:User
		"ROLE_USER"
	],
	"userSource": 1  # 0:内部用户 或 1:外部用户(设置无效)
}
Response: 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxUser>
    <createDate>2019-12-24T07:51:17.067Z</createDate>
    <id>34</id>
    <owner>Admin</owner>
    <updateDate>2019-12-24T07:51:17.067Z</updateDate>
    <updatedBy>Admin</updatedBy>
    <description>zhangsan - add from postman</description>
    <firstName>zhangsan</firstName>
    <isVisible>1</isVisible>
    <lastName>zhangsan</lastName>
    <name>zhangsan</name>
    <password>*****</password>
    <userRoleList>ROLE_USER</userRoleList>
    <userSource>0</userSource>
</vxUser>

在这里插入图片描述
在这里插入图片描述

根据id删除用户

DELETE /xusers/users/{id}
DELETE /xusers/secure/users/id/{userId}

  • 软删除(即将用户状态设为Hidden)
    http://host.domain:6080/service/xusers/users/{id}
    http://host.domain:6080/service/xusers/secure/users/id/{id}
  • 硬删除(即从ranger中移除用户数据),URL末尾添加参数:?forceDelete=true
    http://host.domain:6080/service/xusers/users/{id}?forceDelete=true
    http://host.domain:6080/service/xusers/secure/users/id/{id}?forceDelete=true
API Name: Delete Service
Request Type: Delete
Request URL: 
	http://host.domain:6080/service/xusers/users/34
	http://host.domain:6080/service/xusers/secure/users/id/34
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 

根据username删除用户

DELETE /xusers/users/userName/{username}
DELETE /xusers/secure/users/{username}

  • 软删除(即将用户状态设为Hidden)
    http://host.domain:6080/service/xusers/users/userName/{username}
    http://host.domain:6080/service/xusers/secure/users/{username}
  • 硬删除(即从ranger中移除用户数据),URL末尾添加参数:?forceDelete=true
    http://host.domain:6080/service/xusers/users/userName/{username}?forceDelete=true
    http://host.domain:6080/service/xusers/secure/users/{username}?forceDelete=true
API Name: Delete Service
Request Type: Delete
Request URL: 
	http://host.domain:6080/service/xusers/users/userName/wangwu
	http://host.domain:6080/service/xusers/secure/users/wangwu
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 

在这里插入图片描述

获取全部用户信息

GET /xusers/users

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/users
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxUserList>
    <pageSize>200</pageSize>
    <resultSize>36</resultSize>
    <sortBy>id</sortBy>
    <sortType>asc</sortType>
    <startIndex>0</startIndex>
    <totalCount>36</totalCount>
    <vXUsers>
        <createDate>2019-11-28T04:36:25Z</createDate>
        <id>1</id>
        <updateDate>2019-11-28T04:36:25Z</updateDate>
        <description>Administrator</description>
        <firstName>Admin</firstName>
        <isVisible>1</isVisible>
        <lastName></lastName>
        <name>admin</name>
        <password>*****</password>
        <userRoleList>ROLE_SYS_ADMIN</userRoleList>
        <userSource>0</userSource>
    </vXUsers>
    所有用户信息。。。。。。。

获取用户总数

GET /xusers/users/count

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/users/count
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxLong>
    <value>35</value>
</vxLong>

在这里插入图片描述

根据id获取用户信息

GET /xusers/users/{id}
GET /xusers/secure/users/{id}

扫描二维码关注公众号,回复: 10883156 查看本文章
API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/users/15
	http://host.domain:6080/service/xusers/secure/users/15
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxUser>
    <createDate>2019-11-28T04:37:34Z</createDate>
    <id>15</id>
    <owner>rangerusersync</owner>
    <updateDate>2019-11-28T04:37:34Z</updateDate>
    <updatedBy>rangerusersync</updatedBy>
    <description>ranger - add from Unix box</description>
    <firstName>ranger</firstName>
    <groupIdList>2</groupIdList>
    <groupIdList>4</groupIdList>
    <groupNameList>hadoop</groupNameList>
    <groupNameList>ranger</groupNameList>
    <isVisible>1</isVisible>
    <lastName>ranger</lastName>
    <name>ranger</name>
    <password>*****</password>
    <userRoleList>ROLE_USER</userRoleList>
    <userSource>1</userSource>
</vxUser>

在这里插入图片描述

根据username获取用户信息

GET /xusers/users/userName/{userName}

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/users/userName/wangwu1
	
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxUser>
    <createDate>2019-12-24T08:08:32Z</createDate>
    <id>37</id>
    <owner>Admin</owner>
    <updateDate>2019-12-24T08:15:36Z</updateDate>
    <updatedBy>Admin</updatedBy>
    <description>wangwu1 - add from postman</description>
    <firstName>wangwu1</firstName>
    <isVisible>0</isVisible>
    <lastName>wangwu1</lastName>
    <name>wangwu1</name>
    <password>*****</password>
    <userRoleList>ROLE_USER</userRoleList>
    <userSource>0</userSource>
</vxUser>

在这里插入图片描述

根据username获取role信息

GET /xusers/secure/users/roles/userName/{userName}

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/secure/users/roles/userName/wangwu1
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:

在这里插入图片描述

用户组管理API(Group APIs)

创建用户组

POST /xusers/secure/groups
POST /xusers/groups

API Name: POST Service
Request Type: POST
Request URL: 
	http://host.domain:6080/service/xusers/secure/groups
	http://host.domain:6080/service/xusers/groups
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
{
	"name": "zhouyuan-group",
	"description": "zhouyuan - add from ambari",
	"groupSource": 1
}
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxGroup>
    <createDate>2019-12-24T08:36:55.984Z</createDate>
    <id>16</id>
    <owner>Admin</owner>
    <updateDate>2019-12-24T08:36:55.984Z</updateDate>
    <updatedBy>Admin</updatedBy>
    <description>zhouyuan - add from ambari</description>
    <groupSource>1</groupSource>
    <groupType>0</groupType>
    <isVisible>1</isVisible>
    <name>zhouyuan-group</name>
</vxGroup>

在这里插入图片描述

根据id删除用户组

根据groupname删除用户组

DELETE /xusers/groups/groupName/{groupName}
DELETE /xusers/secure/groups/{groupName}

  • 软删除(即将用户组状态设为Hidden)
    http://host.domain:6080/service/xusers/groups/groupName/{groupname}
    http://host.domain:6080/service/xusers/secure/groups/{groupname}?forceDelete=true
  • 硬删除(即从ranger中移除用户组数据),URL末尾添加参数:?forceDelete=true
    http://host.domain:6080/service/xusers/groups/groupName/{groupname}?forceDelete=true
    http://host.domain:6080/service/xusers/secure/groups/{groupname}?forceDelete=true
API Name: Delete Service
Request Type: Delete
Request URL: http://host.domain:6080/service/xusers/groups/groupName/zhouyuan-group?forceDelete=true
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response: 

获取全部用户组信息

GET /xusers/groups

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/groups
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxGroupList>
    <pageSize>200</pageSize>
    <resultSize>16</resultSize>
    <sortBy>id</sortBy>
    <sortType>asc</sortType>
    <startIndex>0</startIndex>
    <totalCount>16</totalCount>
    <vXGroups>
        <createDate>2019-11-28T04:36:25Z</createDate>
        <id>1</id>
        <owner>Admin</owner>
        <updateDate>2019-11-28T04:36:25Z</updateDate>
        <updatedBy>Admin</updatedBy>
        <description>public group</description>
        <groupSource>0</groupSource>
        <groupType>0</groupType>
        <isVisible>1</isVisible>
        <name>public</name>
    </vXGroups>
    所有用户组信息。。。。。。。

在这里插入图片描述

获取用户组总数

GET /xusers/groups/count

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/groups/count
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxLong>
    <value>16</value>
</vxLong>

在这里插入图片描述

根据id获取用户组信息

GET /xusers/groups/{id}
GET /xusers/secure/groups/{id}

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/groups/20
	http://host.domain:6080/service/xusers/secure/groups/20
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxGroup>
    <createDate>2019-12-24T08:51:28Z</createDate>
    <id>20</id>
    <owner>Admin</owner>
    <updateDate>2019-12-24T08:51:28Z</updateDate>
    <updatedBy>Admin</updatedBy>
    <description>zhouyuan - add from ambari</description>
    <groupSource>1</groupSource>
    <groupType>0</groupType>
    <isVisible>1</isVisible>
    <name>zhouyuan-group</name>
</vxGroup>

在这里插入图片描述

根据groupname获取用户组信息

GET /xusers/groups/groupName/{groupName}

API Name: Get Service
Request Type: GET
Request URL: 
	http://host.domain:6080/service/xusers/groups/groupName/zhouyuan-group
Authorization: 
	Type: Basic Auth
	Username: admin
	Password: admin
Headers: 
Body: 
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxGroup>
    <createDate>2019-12-24T08:51:28Z</createDate>
    <id>20</id>
    <owner>Admin</owner>
    <updateDate>2019-12-24T08:51:28Z</updateDate>
    <updatedBy>Admin</updatedBy>
    <description>zhouyuan - add from ambari</description>
    <groupSource>1</groupSource>
    <groupType>0</groupType>
    <isVisible>1</isVisible>
    <name>zhouyuan-group</name>
</vxGroup>

在这里插入图片描述
参考:

  1. http://ranger.apache.org/apidocs/ui/index.html
  2. http://ranger.apache.org/apidocs/index.html
发布了153 篇原创文章 · 获赞 122 · 访问量 9万+

猜你喜欢

转载自blog.csdn.net/Happy_Sunshine_Boy/article/details/103682857