搜索角色 API
使用搜索角色 API 检索 Control Room 中的所有角色列表。
先决条件
确保您具有管理员角色或具有查看角色权限的自定义角色,以搜索角色。
过程
- 将认证令牌添加到请求标头。
- 应用筛选器执行基本条件查询和分页控制,以处理网页。有三个与筛选相关的基本功能:筛选条件、排序列和分页参数。请参阅 API 请求正文中的筛选器。
-
使用 POST 方法和端点 URL:
<your control room>/v1/usermanagement/roles/list
以下请求查找名称
包含test
且创建于 2020 年 6 月 1 日至 10 月 6 日期间的角色。请求正文:{ "fields": [], "filter": { "operator": "and", "operands": [ { "operator": "substring", "field": "name", "value": "test" }, { "operator": "gt", "field": "createdOn", "value": "2020-06-01T00:00:00.989Z" }, { "operator": "lt", "field": "createdOn", "value": "2020-10-06T23:00:00.123Z" } ] } }
-
发送请求
在本示例中,响应正文提供了五个名称包含
test
的角色,以及创建角色的时间和人员,和角色是否为系统创建角色。响应正文:{ "page": { "offset": 0, "total": 106, "totalFilter": 5 }, "list": [ { "id": 102, "name": "whatfixtest", "description": "", "countPrincipals": 0, "version": 3, "createdBy": 278, "createdOn": "2020-06-02T18:22:55.633Z", "updatedBy": 34, "updatedOn": "2020-09-02T23:26:11.930Z", "systemRole": false }, { "id": 115, "name": "export-role-test", "description": "", "countPrincipals": 5, "version": 8, "createdBy": 261, "createdOn": "2020-06-04T10:59:45.343Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:33.310Z", "systemRole": false }, { "id": 391, "name": "testROle", "description": "", "countPrincipals": 0, "version": 0, "createdBy": 169, "createdOn": "2020-07-01T01:08:45.243Z", "updatedBy": 169, "updatedOn": "2020-07-01T01:08:45.243Z", "systemRole": false }, { "id": 401, "name": "bi-test-role", "description": "", "countPrincipals": 1, "version": 5, "createdBy": 1, "createdOn": "2020-07-02T02:56:57.893Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:33.280Z", "systemRole": false }, { "id": 470, "name": "repo_test", "description": "", "countPrincipals": 1, "version": 1, "createdBy": 1, "createdOn": "2020-09-09T07:49:46.993Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:32.913Z", "systemRole": false } ] }
REST API 用 HTTP 响应代码响应每个请求。有关响应代码的详细信息,请参阅 API 响应代码。