userGroups

URI

<securityManager_uri>/usergroups[.<format>]

支持的方法

GET、POST、PUT、HEAD

父资源

securityManager

子资源

userGroup

介绍

查看和管理当前 GIS 系统中的所有用户组。管理员可查看、添加和删除用户组。

支持的方法：

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

资源层次

HTTP 请求方法

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

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

GET 请求

查看当前 GIS 系统中的所有用户组。

响应结构

对 userGroups 资源执行 GET 请求，返回当前 GIS 系统中的所有用户组，由以下几个字段组成

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

响应示例

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

[

    {

        "roles": [

            "NOPASSWORD"

        ],

        "name": "THIRD_PART_AUTHORIZED",

        "description": "",

        "users": []

    },

    {

        "roles": [

            "PORTAL_USER",

            "DATA_CENTER"

        ],

        "name": "test",

        "description": "Test account",

        "users": [

            "test1",

            "test2"

        ]

    }

]

POST 请求

添加一个用户组。

请求参数

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

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

 

响应结构

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

字段 类型 说明
newResourceID String 新用户的名字。
newResourceLocation String 新用户的资源地址。
postResultType String 值为 CreateChild 。
succeed boolean 是否成功添加新用户。

响应示例

对 userGroups 资源 http://localhost:8190/iportal/manager/security/usergroups.json 执行 POST 请求，添加一个用户组，发送的请求体如下：

{

    "name": "test",

    "description": "Test account",

    "roles": [

        "PORTAL_USER",

        "DATA_CENTER"

    ],

    "users": [

        "test1",

        "test2"

    ]

}

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

{

    "postResultType": "CreateChild",

    "newResourceID": "test",

    "succeed": true,

    "newResourceLocation": "http://localhost:8190/iportal/manager/security/usergroups/test.json"

}

PUT 请求

批量删除已创建的用户组。

请求参数

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

响应结构

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

字段 类型 说明

succeed

 boolean 是否成功删除用户组。

响应示例

对 userGroups 资源 http://localhost:8190/iportal/manager/security/usergroups.json 执行 PUT 请求，可以批量删除已创建的用户组，发送的请求体如下：

[

    "test"

]

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

{

    "succeed": true

}HEAD 请求

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

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

请参见