users


URI

<security_uri>/users[.<format>]

支持的方法

GETPOSTPUTHEAD

父资源

securityManager

子资源

user

介绍

users 资源为用户管理资源,通过该资源您可以获取当前 GIS 系统中的用户列表及其相关信息,可以添加新用户和批量删除已创建用户。

支持的方法:

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

资源层次

HTTP 请求方法

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

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

GET 请求

获取当前 GIS 系统中的用户列表及其相关信息。

响应示例

对 users 资源执行 GET 请求(http://localhost:8090/iserver/manager/security/users.rjson),返回结果为 Sting 类型的用户信息二维数组,其中每个用户的信息包括用户名、用户描述、用户关联的角色、用户是否被锁定以及用户账号的过期时间。对应的 rjson 格式响应结果如下:

[

    [

        "admin",

        "",

        "ADMIN",

        "false",

        "null"

    ],

    [

        "guest",

        "",

        "PUBLISHER",

        "false",

        "null"

    ]

]

POST 请求

添加新用户。

请求参数

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

名称 类型 含义
name String 【必选参数】
用户名称。
password String 【必选参数】
用户密码。密码要求至少包含大、小写字母、数字或特殊字符中的三种。
description String 用户描述信息。
roles String[] 用户关联角色。
userGroups String[] 用户隶属的用户组。

响应结构

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

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

响应示例

对 users 资源 http://localhost:8090/iserver/manager/security/users.rjson 执行 POST 请求,可以添加新用户,发送的请求体如下:

{

    "name": "guest1",

    "password": "123456",

    "description": "",

    "roles": [

        "PUBLISHER"

    ],

    "userGroups": []

}

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

{

    "newResourceID": "guest1",

    "newResourceLocation": "http://localhost:8090/iserver/manager/security/users/guest1.rjson",

    "postResultType": "CreateChild",

    "succeed": true

}

PUT 请求

批量删除已创建用户。

请求参数

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

响应结构

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

字段 类型 说明

succeed

boolean 是否成功删除用户。

响应示例

对 users 资源 http://localhost:8090/iserver/manager/security/users.rjson 执行 PUT 请求,可以批量删除已创建用户,发送的请求体如下:

[

    "guest1"

]

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

{

    "succeed": true

}

HEAD 请求

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

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

请参见