roles

 URI

<security_uri>/roles[.<format>]

支持的方法

GET、POST、PUT、HEAD

父资源

securityManager

子资源

role

介绍

roles 资源为角色管理资源，通过该资源您可以获取当前 GIS 系统中的角色列表及其配置信息，可以添加新角色和批量删除已创建角色。

支持的方法：

• GET：获取当前 GIS 系统中的角色列表及其配置信息。
• POST：添加新角色。
• PUT：批量删除已创建角色。
• HEAD：检查 roles 资源是否存在，或权限是否可以访问 roles 资源。

支持的表述格式：RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiserver 是服务器名。

http://supermapiserver:8090/iserver/manager/security/roles.rjson

GET 请求

获取当前 GIS 系统中的角色列表及其配置信息。

响应结构

对 roles 资源执行 GET 请求，返回的是一个角色列表，其中单个角色的表述结构如下:

响应示例

对 roles 资源执行 GET 请求（http://localhost:8090/iserver/manager/security/roles.rjson），返回的 rjson 格式响应结果如下：

[ { "description": "内置的系统管理员角色，此角色默认拥有整个 iServer 的管理权限。", "name": "ADMIN", "permissions": { "componentManagerPermissions": { "denied": [], "permitted": [] }, "instanceAccessPermissions": { "denied": [], "permitted": [] }, "publishEnabled": false }, "userGroups": [], "users": [ "admin" ] }, { "description": "", "name": "UNAUTHORIZED", "permissions": { "componentManagerPermissions": { "denied": [], "permitted": [] }, "instanceAccessPermissions": { "denied": [], "permitted": [] }, "publishEnabled": false }, "userGroups": [ "THIRD_PART_AUTHORIZED" ], "users": [] }, { "description": "内置的服务发布者角色，此角色默认拥有服务发布和服务实例管理的权限。", "name": "PUBLISHER", "permissions": { "componentManagerPermissions": { "denied": [], "permitted": [] }, "instanceAccessPermissions": { "denied": [], "permitted": [] }, "publishEnabled": true }, "userGroups": [], "users": [] }, { "description": "", "name": "NOPASSWORD", "permissions": { "componentManagerPermissions": { "denied": [], "permitted": [] }, "instanceAccessPermissions": { "denied": [], "permitted": [] }, "publishEnabled": false }, "userGroups": [ "THIRD_PART_AUTHORIZED" ], "users": [] }, { "description": "内置的 iPortal 用户角色。", "name": "PORTAL_USER", "permissions": { "componentManagerPermissions": { "denied": [], "permitted": [] }, "instanceAccessPermissions": { "denied": [], "permitted": [] }, "publishEnabled": false }, "userGroups": [], "users": [] } ]

POST 请求

添加新角色。

请求参数

发送请求时，需要在请求体中包含如下参数：

响应结构

执行 POST 请求后，返回的资源表述结构如下：

响应示例

对 roles 资源 http://localhost:8090/iserver/manager/security/roles.rjson 执行 POST 请求，可以添加新角色，发送的请求体如下：

{

    "name": "ROLE1",

    "description": "创建的第一个角色",

    "permissions": {

        "publishEnabled": false

    },

    "users": [

        "guest1"

    ],

    "userGroups": []

}

则返回的 rjson 格式响应结果如下：

{

    "newResourceID": "ROLE1",

    "newResourceLocation": "http://localhost:8090/iserver/manager/security/roles/ROLE1.rjson",

    "postResultType": "CreateChild",

    "succeed": true

}

PUT 请求

批量删除已创建角色。

请求参数

发送请求时，请求体为角色名称构成的 String 类型一维数组。

响应结构

执行 PUT 请求后，返回的资源表述结构如下：

响应示例

对 roles 资源 http://localhost:8090/iserver/manager/security/roles.rjson 执行 PUT 请求，可以批量删除已创建角色，发送的请求体如下：

[

    "ROLE1"

]

则返回的 rjson 格式响应结果如下：

{

    "succeed": true

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 roles 资源是否存在，或者客户端是否有权限访问 roles 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 roles 资源是否支持<format>格式的表述。

请参见

• securityManager、role
• 客户端构建 REST 请求
• 状态码列表及说明
• SuperMap iServer REST API 表述格式介绍
• 资源层次结构