AIPAAS文档中心Appearance
用户管理接口 #
复制用户 #
将已经存在于人脸库中的用户复制到一个新的组
- 请求路径
/face-api/v3/user/copy
- Header：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
| token | 令牌 |
- Body请求参数
| 参数 | 必选 | 类型 | 说明 |
|---|---|---|---|
| user_id | 是 | string | 用户id |
| src_group_id | 是 | string | 从指定group里复制 长度限制40B |
| dst_group_id | 是 | string | 需要添加用户的组id 长度限制40B |
- 请求示例
{
"user_id": "user1",
"src_group_id": "group1",
"dst_group_id": "group2"
}
- 返回结果 通过返回的error_code判断是否成功 如失败则查看error_msg获得具体错误信息
{
"error_code": 0,
"error_msg": "SUCCESS",
"log_id": 1234567890123,
"timestamp": 1533094714,
"cached": 0,
"result": null
}
获取用户信息 #
获取人脸库中某个用户的信息(user_info信息和用户所属的组)
- 请求路径
/face-api/v3/user/get
- Header：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
| token | 令牌 |
- Body请求参数
| 参数 | 必选 | 类型 | 说明 |
|---|---|---|---|
| user_id | 是 | string | 用户id（由数字、字母、下划线组成），长度限制40B |
| group_id | 是 | string | 用户组id(由数字、字母、下划线组成，长度限制40B) 如传入**@ALL**则从所有组中查询用户信息 |
- 请求示例
{
"user_id": "user1",
"group_id": "group1"
}
- 返回结果
| 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|
| user_list | 是 | array | 用户信息列表 |
| +user_info | 是 | string | 用户注册时携带的用户信息 |
| +group_id | 是 | string | 用户所属的group_id |
- 返回示例
{
"error_code": 0,
"error_msg": "SUCCESS",
"log_id": 1234567890123,
"timestamp": 1533094729,
"cached": 0,
"result": {
"user_list": [
{
"user_info": "user info ...",
"group_id": "gid1"
},
{
"user_info": "user info2 ...",
"group_id": "gid2"
}
]
}
}
用户列表 #
获取用户组中的用户列表
- 请求路径
/face-api/v3/user/list
- Header：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
| token | 令牌 |
- Body请求参数
| 参数 | 必选 | 类型 | 说明 |
|---|---|---|---|
| group_id | 是 | string | 用户组id |
| start | 否 | uint32 | 默认值0，起始序号 |
| length | 否 | uint32 | 返回数量，默认值100，最大值1000 |
- 请求示例
{
"group_id": "group1"
}
- 返回结果
| 字段 | 必选 | 类型 | 说明 |
|---|---|---|---|
| user_id_list | 是 | array | 用户ID列表 |
- 返回示例
{
"error_code": 0,
"error_msg": "SUCCESS",
"log_id": 1234567890123,
"timestamp": 1533094739,
"cached": 0,
"result": {
"user_id_list": [
"uid1",
"uid2"
]
}
}
删除用户 #
将用户从某个组中删除
- 请求路径
/face-api/v3/user/delete
- Header：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
| token | 令牌 |
- Body请求参数
| 参数 | 必选 | 类型 | 说明 |
|---|---|---|---|
| group_id | 是 | string | 用户组id(由数字、字母、下划线组成，长度限制40B) 如传入**@ALL**则从所有组中删除用户 |
| user_id | 是 | string | 用户id(由数字、字母、下划线组成，长度限制40B) |
- 请求示例
{
"user_id": "user1",
"group_id": "group1"
}
- 返回结果 通过返回的error_code判断是否成功 如失败则查看error_msg获得具体错误信息
{
"error_code": 0,
"error_msg": "SUCCESS",
"log_id": 1234567890123,
"timestamp": 1533094766,
"cached": 0,
"result": null
}