查询用户列表 - IDMesh APIs

请求参数

Query 参数

page_size

integer

可选

示例值:

10

page_num

integer

可选

示例值:

1

search_type

string

可选

search_type查询类型：generic（全文搜索）、不填（基础搜索）
默认基础搜索：/v1/users?username=xxx&display_name=xxx......
全文检索：/v1/users?keyword=xxx
高级检索：/v1/users?username[eq]=xxx&time_created[gt]=xxx
扩展字段检索：/v1/users?sys_ext_props[xxx][eq]=xxx&sys_ext_props[xxx][gt]=xxx
eq：等于（equal）
ne：不等于（not equal）
gt：大于（greater than）
lt：小于（less than）
gte：大于等于（greater than or equal to）
lte：小于等于（less than or equal to）
in：在给定范围内（in a given range）
like：模糊匹配，包含
notlike：不匹配，不包含
orderby：排序的顺序（order by）

常规查询字段：
username //用户名
display_name //显示名
firstname //名
lastname //姓
realname //真实姓名
pinyin //拼音
nickname //昵称
user_type //用户类型
mobile //手机
email //邮件
phone_number //电话
gender //性别
cert_type //证件类型
cert_number //证件号
region //地区
work_time //加入时间
work_title //职位
arn //ARN
developer_id //开发者ID
tenant_id //租户ID
last_login_ipaddr //上次登录IP
last_login_time //上次登录时间
time_modified //修改时间
status //状态
external_id //同步自外部系统的ID

keyword

string

检索值

可选

time_modified_from

string

开始时间

可选

time_modified_to

string

结束时间

可选

page_mode

string

可选

是否分页，默认1分页 0 不分页

is_ret_node

boolean

可选

是否返回组织，默认false 不反回 true 返回

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/v1/users?page_size=10&page_num=1&search_type=&keyword=&time_modified_from&time_modified_to&page_mode&is_ret_node'

返回响应

🟢200成功

application/json

Body

data

array[object (UserRes) {34}]

返回用户列表

可选

id

string

用户id标识

可选

username

string

用户名，唯一

可选

password

string

密码

可选

password_status

string

可选

valid 有效，invalid 无效强制修改，init初始待生效

password_expire_time

密码过期时间

可选

display_name

string

显示名称

可选

firstname

string

名

可选

lastname

string

姓

可选

realname

string

真实姓名

可选

pinyin

string

拼音

可选

nickname

string

昵称

可选

user_type

string

用户类型

可选

mobile

string

手机

可选

email

string

邮箱

可选

gender

string

性别

可选

cert_type

string

证件类型

可选

cert_number

string

证件号

可选

region

string

区域

可选

work_time

加入时间

可选

work_title

string

职位

可选

arn

string

arn

可选

idp_config_id

number

身份源ID

可选

developer_id

number

开发者id

可选

tenant_id

number

租户id

可选

last_login_ipaddr

string

上次登录IP

可选

last_login_time

上次登录时间

可选

time_created

创建时间

可选

time_modified

修改时间

可选

status

string

可选

状态：1正常，0禁用

password_locked

boolean

可选

此属性正常不返回，当用户登录密码锁定时返回true

sys_ext_props

object

系统扩展字段

可选

free_ext_props

object

自由扩展字段

可选

external_id

string

可选

同步自外部系统的ID

work_status

string

可选

工作状态：1在职， 2离职，0空

total_num

number

总数

可选

page_num

number

当前页

可选

示例

{
    "data": [
        {
            "id": "string",
            "username": "string",
            "password": "string",
            "password_status": "string",
            "password_expire_time": null,
            "display_name": "string",
            "firstname": "string",
            "lastname": "string",
            "realname": "string",
            "pinyin": "string",
            "nickname": "string",
            "user_type": "string",
            "mobile": "string",
            "email": "string",
            "gender": "string",
            "cert_type": "string",
            "cert_number": "string",
            "region": "string",
            "work_time": null,
            "work_title": "string",
            "arn": "string",
            "idp_config_id": 0,
            "developer_id": 0,
            "tenant_id": 0,
            "last_login_ipaddr": "string",
            "last_login_time": null,
            "time_created": null,
            "time_modified": null,
            "status": "string",
            "password_locked": true,
            "sys_ext_props": {},
            "free_ext_props": {},
            "external_id": "string",
            "work_status": "string"
        }
    ],
    "total_num": 0,
    "page_num": 0
}

🟠400参数错误