调用ListUsers获取用户列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListUsers

系统规定参数。取值:ListUsers。

DepartmentId String 59b0bbfe-929b-4a8c-9833-3ce70b4bad38

部门id

PageIndex Integer 1

分页码

PageSize Integer 10

页大小

Username String tom

搜索指定用户名

返回数据

名称 类型 示例值 描述
Code String OK
Data Struct

-

Items Array of Items

数据

CreatedAt String 2020-07-14T14:01:41.000+08:00

创建日期

Departments Array of Departments

所属部门列表

CreatedAt String 2020-07-14T14:01:41.000+08:00

创建日期

Description String 部门

描述

Id String 59b0bbfe-929b-4a8c-9833-3ce70b4bad38

id

Name String 不明

部门名称

UpdatedAt String 2020-07-14T14:01:41.000+08:00

更新日期

Email String a@a.com

电子邮件

Id String 2020-07-14T14:01:41.000+08:00

id

Name String 高x

姓名

PhoneNumber String 186000000

手机号码

RamUsername String xxx

RAM用户名

Role String admin

角色

Source String ram

用户来源

UpdatedAt String 2020-07-14T14:01:41.000+08:00

更新日期

Username String xxx

用户名

TotalElements Long 10

总条数

TotalPages Integer 1

总页数

Message String -
RequestId String 59b0bbfe-929b-4a8c-9833-3ce70b4bad38

示例

请求示例

http(s)://[Endpoint]/?Action=ListUsers
&<公共请求参数>

正常返回示例

XML 格式

<Message>-</Message>
<RequestId>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</RequestId>
<Data>
    <TotalElements>10</TotalElements>
    <TotalPages>1</TotalPages>
    <Items>
        <Role>admin</Role>
        <Email>a@a.com</Email>
        <Username>xxx</Username>
        <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>
        <RamUsername>xxx</RamUsername>
        <PhoneNumber>186000000</PhoneNumber>
        <Id>2020-07-14T14:01:41.000+08:00</Id>
        <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>
        <Source>ram</Source>
        <Name>高x</Name>
        <Departments>
            <Description>部门</Description>
            <CreatedAt>2020-07-14T14:01:41.000+08:00</CreatedAt>
            <Id>59b0bbfe-929b-4a8c-9833-3ce70b4bad38</Id>
            <UpdatedAt>2020-07-14T14:01:41.000+08:00</UpdatedAt>
            <Name>不明</Name>
        </Departments>
    </Items>
</Data>
<Code>OK</Code>

JSON 格式

{
    "Message": "-",
    "RequestId": "59b0bbfe-929b-4a8c-9833-3ce70b4bad38",
    "Data": {
        "TotalElements": 10,
        "TotalPages": 1,
        "Items": [
            {
                "Role": "admin",
                "Email": "a@a.com",
                "Username": "xxx",
                "CreatedAt": "2020-07-14T14:01:41.000+08:00",
                "RamUsername": "xxx",
                "PhoneNumber": 186000000,
                "Id": "2020-07-14T14:01:41.000+08:00",
                "UpdatedAt": "2020-07-14T14:01:41.000+08:00",
                "Source": "ram",
                "Name": "高x",
                "Departments": {
                    "Description": "部门",
                    "CreatedAt": "2020-07-14T14:01:41.000+08:00",
                    "Id": "59b0bbfe-929b-4a8c-9833-3ce70b4bad38",
                    "UpdatedAt": "2020-07-14T14:01:41.000+08:00",
                    "Name": "不明"
                }
            }
        ]
    },
    "Code": "OK"
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden Access to this resource on the server is denied. 没有权限访问该资源
500 InternalServerError An internal server error occurred. 服务器内部出错
400 InvalidRequest The request is invalid. 无效的请求
404 ResourceNotFound The specified resource does not exist. 找不到指定的资源
401 Unauthorized The request requires user authentication. 该请求需要进行身份认证

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。