获取用户列表 - api-server

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization-Type

string

必需

默认值:

X-Authorization

string

必需

默认值:

Body 参数application/json

unPage

boolean

是否分页，默认不分

可选

示例值:

false

pageNumber

integer <int64>

第几页，默认第1页

可选

示例值:

1

sorting

string

是否排序

可选

示例值:

sortingDirection

string

排序方向，默认递增

可选

示例值:

name

string

昵称，如超级管理员

可选

示例值:

tenantId

string

租户ID

可选

示例值:

pageSize

integer <int64>

可选

分页大小，默认10条

示例值:

10

userName

string

用户名

可选

示例值:

示例

{
    "unPage": false,
    "pageNumber": 1,
    "sorting": "",
    "sortingDirection": "",
    "name": "",
    "tenantId": "",
    "pageSize": 10,
    "userName": ""
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://iot-dev.utapp.cn/api/user/list' \
--header 'Authorization-Type;' \
--header 'X-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "unPage": false,
    "pageNumber": 1,
    "sorting": "",
    "sortingDirection": "",
    "name": "",
    "tenantId": "",
    "pageSize": 10,
    "userName": ""
}'

返回响应

🟢200成功

application/json

Body

totalCount

integer <int64>

可选

示例值:

0

items

array [object {10}]

可选

secretKey

string

鉴权SK

可选

示例值:

phone

string

电话

可选

示例值:

accessKey

string

鉴权AK

可选

示例值:

name

string

昵称

可选

示例值:

pwd

string

密码

可选

示例值:

userName

string

用户名，登陆用

可选

示例值:

type

string

类型，如宿主

可选

示例值:

email

string

邮箱

可选

示例值:

faceImage

string

头像地址

可选

示例值:

roles

array[object (RoleExitsDto) {3}]

是否包含角色

可选

示例

{
    "totalCount": 0,
    "items": [
        {
            "secretKey": "",
            "phone": "",
            "accessKey": "",
            "name": "",
            "pwd": "",
            "userName": "",
            "type": "",
            "email": "",
            "faceImage": "",
            "roles": [
                {
                    "roleCode": "string",
                    "roleName": "string",
                    "assigned": true
                }
            ]
        }
    ]
}