获取用户列表

POST

/public-api/user/list

接口简介

查询用户信息列表，是否支持返回用户属性的别名，封装用户属性配置信息的类。

请求参数

Body 参数application/json

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

userPropertyType

enum<number>

用户属性类型

可选

枚举值:

默认值:

示例

{
    "token": "string",
    "userPropertyType": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/user/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "userPropertyType": 0
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

array [object {12}]

响应结果

必需

uId

string

用户ID

必需

name

string

名称

必需

mobile

string

手机号

必需

string

邮箱

必需

loginId

string

登录ID

必需

domId

string

域id

必需

role

array[string]

角色

必需

enabled

boolean

是否启用

必需

config

object

用户属性

可选

内置属性和自定义属性

lastLoginTime

string

可选

ctime

string

创建时间

可选

isDel

boolean

是否删除

必需

示例

{
    "result": "ok",
    "response": [
        {
            "id": 760,
            "uId": "m5b7407230a3a4fda87b8f6b",
            "name": "王某某",
            "mobile": "135xxxxxxxx",
            "email": "wmm@guandata.com",
            "loginId": "wmm@guandata.com",
            "domId": "testing",
            "role": [
                "admin"
            ],
            "config": {
                "theme": "LIGHT",
                "locale": "zh-CN",
                "userProperties": {
                    "feishu": "子公司111",
                    "gender": ""
                },
                "userGuideVersion": "6.6.0"
            },
            "lastLoginTime": "2023-05-16 15:15:31+0800",
            "enabled": true,
            "ctime": "2019-08-08 15:54:20+0800",
            "isDel": false
        }
    ]
}

修改于 2025-07-16 01:54:33

批量获取用户是否存在

通过属性值获取用户列表