userGroup


URI

<userGroups_uri>/{userGroupName}[.<format>]

支持的方法

GETPUTDELETEHEAD

父资源

userGroups

介绍

管理员可根据用户组名称查看具体的用户组、修改用户组、删除用户组。

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiserver:8090/iserver/manager/security/usergroups/{userGroupName}.rjson

GET 请求

根据用户组名称查看具体的用户组。

响应结构

对 userGroups 资源执行 GET 请求,返回指定用户组的信息,由以下几个字段组成

字段 类型 说明
name String 用户组名
description String 用户组的简要描述信息
roles String[] 用户组关联的角色
users String [] 用户组中包含的用户

响应示例

对 userGroup 资源 http://localhost:8190/iportal/manager/security/usergroups/test.rjson 执行 GET 请求,返回 rjson 格式的资源表述如下:

{

    "roles": [

        "PORTAL_USER",

        "DATA_CENTER"

    ],

    "name": "test",

    "description": "Test account",

    "users": [

        "test1",

        "test2"

    ]

}

PUT 请求

修改用户组的信息。

请求参数

发送请求时,需要在请求体中包含如下参数。其中,用户组名称不可更改,其他参数都为可选参数。

字段 类型 说明
name String 用户组名
description String 用户组的简要描述信息
roles String[] 用户组关联的角色
users String [] 用户组中包含的用户

响应结构

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

字段 类型 说明

succeed

boolean 是否成功修改指定用户组的信息。

响应示例

对 userGroup 资源 http://localhost:8190/iportal/manager/security/usergroups/test.rjson 执行 PUT 请求,发送的请求体如下:

{

    "name": "test",

    "description": "Test account",

    "roles": [

        "PORTAL_USER",

        "DATA_CENTER"

    ],

    "users": [

        "test1"

    ]

}

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

{

    "succeed": true

}

DELETE 请求

删除指定的用户组。

响应结构

执行 DELETE 请求后,返回的资源表述结构如下:

字段 类型 说明

succeed

boolean 是否成功删除指定的用户组。

响应示例

对 userGroup 资源 http://localhost:8190/iportal/manager/security/usergroups/test.rjson 执行 DELETE 请求,可以删除由用户组名指定的用户组,返回的 rjson 格式响应结果如下:

{

    "succeed": true

}

HEAD 请求

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

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

请参见