Loading...

    一、用户启用停用

    功能说明

    用户启用停用

    实现方法

    REST URL

    POST /api/rest/external/v1/user/locked?locked=true

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云不存在

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云不存在

    locked

    Boolean

    Query

    true:锁定用户,停用

    false:解锁用户,启用

    5.2-20260928

    公有云不存在

    phones

    List

    Body

    用户账号,与三方 id 二选一

    5.2-20260928

    公有云不存在

    externalUserIds

    List

    Body

    三方id,与用户账号二选一

    5.2-20260928

    公有云不存在

    示例代码

    请求示例

    {
    "phones": ["123456"]
    }

    响应示例

    响应为空。以 http 200 来判断成功


    二、分页查询停用用户

    功能说明

    分页查询停用用户

    实现方法

    REST URL

    GET /api/rest/external/v1/user/locked/query/page

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云不存在

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云不存在

    pageIndex

    int

    Query

    0

    页码,默认为0

    5.2-20260928

    公有云不存在

    pageSize

    int

    Query

    20

    每页大小,默认为10,最大不能超过100

    5.2-20260928

    公有云不存在

    示例代码

    响应示例

    {
    "page": 0,
    "pageTotal": 17,
    "rowsTotal": 34,
    "rows": 2,
    "list": [
    {
    "userId": "UID",
    "username": "张三",
    "email": "user@example.com",
    "phoneNumber": "13800138000"
    }
    ]
    }


    返回参数说明:

    参数

    说明

    userId

    用户id

    username

    姓名

    email

    账号

    phoneNumber

    邮箱