遍历所有用户

请求地址： GET /users

接口说明

分页遍历所有用户。

请求参数

Query

参数名	类型	必需	示例值	说明
offset	integer	否	0	起始下标
limit	integer	否	50	范围（≤1000，默认50）

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/users?offset=0&limit=2
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 5,
        "items": [
            {
                "nickname": "nickname-6ec781f1",
                "guid": "58511d929bff48af95c73645",
                "regDate": "2022-08-31",
                "status": 0,
                "name": "fed_93c7ddc58974402baa37b933"
            },
            {
                "nickname": "nickname-p",
                "guid": "e46c3b76190d4f53a32d7a12",
                "regDate": "2022-08-29",
                "status": 0,
                "name": "fed_account_1"
            }
        ]
    }
}

响应体参数说明

批量更新用户

请求地址： POST /users

接口说明

更新或添加用户，也可以修改密码，会同时修改所有属性。
name不可修改，当name不存在时，会添加用户，否则覆盖用户的属性。

请求参数

Body

参数名	类型	必需	中文名
nickname	string	是	姓名
name	string	是	帐号
status	integer	是	状态
password	string	是	密码

注：需以数组形式传参

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/users
bitkey: xxx
Content-Type: application/json

[
    {
        "name": "u_f12347446",
        "nickname": "user_name",
        "status": 0,
      "password": "pass"
    }
]

响应示例

{
    "status": 0,
    "data": {
        "items": [
            {
                "nickname": "user_name",
                "name": "u_f12347446",
                "status": 0
            }
        ]
    }
}

响应体参数说明

批量更新用户信息

请求地址： PATCH /users

接口说明

更新或添加用户，也可以修改密码，仅修改入参的属性。
name不可修改，当name不存在时，会添加用户。

请求参数

Body

参数名	类型	必需	中文名
nickname	string	否	姓名
name	string	是	帐号
status	integer	否	状态
password	string	否	密码

注：需以数组形式传参

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/users
bitkey: xxx
Content-Type: application/json

[
    {
        "name": "u_f12347446",
        "nickname": "user_name",
        "status": 0,
      "password": "pass"
    }
]

响应示例

{
    "status": 0,
    "data": {
        "items": [
            {
                "nickname": "user_name",
                "name": "u_f12347446",
                "status": 0
            }
        ]
    }
}

响应体参数说明

批量删除用户

请求地址： DELETE /users

接口说明

批量删除用户。

请求参数

Body

参数名类型必需中文名

name string 是用户帐号

参数名	类型	必需	中文名
name	string	是	用户帐号

注：需以数组形式传参

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/users
bitkey: xxx
Content-Type: application/json

[
    {
        "name": "u_f12347446"
    }
]

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "u_f12347446"
            }
        ]
    }
}

按条件检查用户

请求地址： POST /users/data

接口说明

按条件检索用户。
返回符合条件的用户列表。

请求参数

Query

参数名	类型	必需	示例值	说明
offset	integer	否	0	起始下标
limit	integer	否	50	范围（≤1000，默认50）

Body

参数名类型必需中文名

querys array 否查询条件

sorts array 否排序条件

参数名	类型	必需	中文名
querys	array	否	查询条件
sorts	array	否	排序条件

支持的参数见下表，检索类型query表示可用于查询，sort表示可用于排序，query|sort表示可用于查询和排序。

参数名类型检索类型必需中文名

name string query|sort 否姓名

参数名	类型	检索类型	必需	中文名
name	string	query\|sort	否	姓名

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/users/data?offset=0&limit=2
bitkey: xxx
Content-Type: application/json

{
    "querys":[
        {
            "name":"name",
            "op":"=",
            "values":[" u_f78b047446"]
        }
    ]
}

检索请求参数用法

响应示例

{
    "status": 0,
    "data": {
        "items": [
            {
                "nickname": "user_name",
                "name": "u_f78b047446",
                "guid": "b1dd23baf0db90de04622087",
                "regDate": "2022-08-30",
                "status": 0
            }
        ]
    }
}

响应体参数说明

检索用户关联的授权码

请求地址： POST /users/sns

接口说明

查询用户关联的授权码。
返回用户的授权码列表，授权在线情况下包含登录的设备以及会话状态信息。

请求参数

Query

参数名	类型	必需	示例值	说明
offset	integer	否	0	起始下标
limit	integer	否	50	范围（≤1000，默认50）

Body

参数名类型必需中文名

querys array 否查询条件

sorts array 否排序条件

参数名	类型	必需	中文名
querys	array	否	查询条件
sorts	array	否	排序条件

支持的参数见下表，检索类型query表示可用于查询，sort表示可用于排序，query|sort表示可用于查询和排序。

参数名类型检索类型必需中文名

sn string query|sort 否授权码

name string query|sort 否帐号

status string query 否状态，有效值有：OFFLINE,ONLINE,DISABLE

参数名	类型	检索类型	必需	中文名
sn	string	query\|sort	否	授权码
name	string	query\|sort	否	帐号
status	string	query	否	状态，有效值有：OFFLINE,ONLINE,DISABLE

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/users/sns?offset=&limit=
bitkey: xxx
Content-Type: application/json

{
    "querys": [
        {
            "name": "sn",
            "op": "=",
            "values": [
                "xxx0",
                "xxx1"
            ]
        }
    ]
}

检索请求参数用法

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "sn": "xxx0",
                "nickname": "昵称🎈",
                "name": "test-account-001",
                "status": "offline"
            }
        ]
    }
}

响应体参数说明

获取一个用户

请求地址： GET /users/user/{name}

接口说明

使用名称获取一个用户。

请求参数

Path

参数名类型必需示例值说明

name string 是 account 帐号

参数名	类型	必需	示例值	说明
name	string	是	account	帐号

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/users/user/u_f78b047446
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "nickname": "user_name",
                "name": "u_f78b047446",
                "guid": "b1dd23baf0db90de04622087",
                "regDate": "2022-08-30",
                "status": 0
            }
        ]
    }
}

响应体参数说明

覆盖一个用户的信息

请求地址： POST /users/user/{name}

接口说明

使用名称覆盖一个用户的信息，会同时更新所有信息。

请求参数

Path

参数名类型必需示例值说明

name string 是 account 帐号
Body

参数名类型必需中文名

nickname string 否姓名

status integer 否状态

password string 否密码

参数名	类型	必需	示例值	说明
name	string	是	account	帐号

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/users/user/u_f78b047446
bitkey: xxx
Content-Type: application/json

{
    "nickname": "nickname",
    "status": 0
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "nickname": "nickname",
                "status": 0,
                "name": "u_f78b047446"
            }
        ]
    }
}

响应体参数说明

更新一个用户

请求地址： PATCH /users/user/{name}

接口说明

使用名称更新一个用户。

请求参数

Path

参数名类型必需示例值说明

name string 是 account 帐号
Body

参数名类型必需中文名

nickname string 否姓名

status integer 否状态

password string 否密码

参数名	类型	必需	示例值	说明
name	string	是	account	帐号

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/users/user/u_f78b047446
bitkey: xxx
Content-Type: application/json

{
    "nickname": "nickname",
    "status": 0
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "nickname": "nickname",
                "status": 0,
                "name": "u_f78b047446"
            }
        ]
    }
}

响应体参数说明

删除指定名称的用户

请求地址： DELETE /users/user/{name}

接口说明

删除指定名称的用户。

请求参数

Path

参数名类型必需示例值说明

name string 是 login_name 用户帐号

参数名	类型	必需	示例值	说明
name	string	是	login_name	用户帐号

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/users/user/u_f78b047446
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "name": "u_f78b047446"
            }
        ]
    }
}