备案控制台
文档
产品文档
输入文档关键字查找
首页

用户管理

更新时间：
一键部署
我的收藏

1用户组管理详情

1.1新建用户组

用户组是管理人员的基础单位，用户组中可以添加用户，也可以将用户组中的智能识别下发到AIBOX或者门禁设备中。

**Path

/solution/community/paas/user/group/add

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

communityId

Long

是

小区ID

userGroupName

String

是

用户组名称

userGroupType

String

是

用户组类型RESIDENT - 居民VISITOR - 访客PROPERTY - 物业BLACKLIST - 黑名单

返回结果

字段名

类型

备注

data

JSON

用户组ID

用户组ID

字段名

类型

备注

userGroupId

String

用户组ID

1.2更新用户组

更新设备组的名称。

**Path

/solution/community/paas/user/group/update

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

userGroupName

String

是

用户组名称

userGroupId

String

是

用户组ID

返回结果

通用网关消息体，无业务字段

1.3删除用户组

用户组布防，是将对应的用户组智能识别同步至边缘AIBOX中，由AIBOX进行人员比对后形成人行数据，后续用户组的用户信息进行变更时，系统会自动进行用户照片的同步。

**Path

/solution/community/paas/user/group/delete

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

userGroupId

String

是

用户组ID

返回结果

通用网关消息体，无业务字段

1.4查询用户组

根据用户组名称查询已有的用户组列表。

**Path

/solution/community/paas/user/group/query

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

communityId

Long

是

小区ID

userGroupName

String

否

用户组名称

pageNo

Integer

是

页码

pageSize

Integer

是

页面数据条数

返回结果

字段名

类型

备注

data

JSONArray

用户组结构

用户组结构

字段名

类型

备注

communityId

Long

小区ID

userGroupId

String

用户组ID

userGroupType

String

用户组类型

userGroupName

String

用户组名称

1.5结构化查询用户信息

根据用户组ID查询组内的用户列表。

**Path

/solution/community/paas/user/query

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

communityId

Long

是

小区ID

userGroupId

String

否

用户组ID

userName

String

否

用户名

mobile

String

否

手机号

pageNo

Integer

是

页码

pageSize

Integer

是

页面数据条数

返回结果

字段名

类型

备注

data

JSONArray

用户结构

人员结构

字段名

类型

备注

identityId

String

用户ID

faceId

String

智能识别ID

userName

String

用户名

faceImageUrl

String

用户图片地址

idNo

String

身份证号

userGroups

JSONArray

用户组列表

age

Integer

年龄

sex

Integer

性别：1男，2女

mobile

String

电话

userGroups详情：

字段名

类型

备注

userGroupId

String

用户组ID

userGroupName

String

用户组名称

userGroupType

String

用户组类型

1.6查询用户信息

通过用户Id或智能识别Id查询人员信息

**Path

/solution/community/paas/user/get

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

communityId

Long

是

小区ID

identityId

String

否

用户ID

faceId

String

否

智能识别ID

返回结果

字段名

类型

备注

data

JSONArray

人员结构

人员结构

字段名

类型

备注

identityId

String

用户ID

faceId

String

智能识别ID

userName

String

用户名

faceImageUrl

String

用户图片地址

idNo

String

身份证号

userGroups

JSONArray

用户组列表

age

Integer

年龄

sex

Integer

性别：1男，2女

mobile

String

电话

userGroups详情：

字段名

类型

备注

userGroupId

String

用户组ID

userGroupName

String

用户组名称

userGroupType

String

用户组类型

1.7智能识别图片查询用户信息

智能识别检索用户，是通过一张用户的照片来检索用户组中的人员信息

**Path

/solution/community/paas/user/getbyimage

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

communityId

Long

是

小区ID

ossFileKey

String

是

智能识别图片地址, OSS文件的KEY

返回结果

字段名

类型

备注

data

JSONArray

人员结构

人员结构

字段名

类型

备注

identityId

String

用户ID

faceId

String

智能识别ID

userName

String

用户名

faceImageUrl

String

用户图片地址

idNo

String

身份证号

userGroups

JSONArray

用户组列表

age

Integer

年龄

sex

Integer

性别：1男，2女

mobile

String

电话

userGroups详情：

字段名

类型

备注

userGroupId

String

用户组ID

userGroupName

String

用户组名称

userGroupType

String

用户组类型

2用户管理详情

2.1添加用户

**Path

/solution/community/paas/user/add

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

userGroupId

String

是

用户组ID

userName

String

是

用户名

mobile

String

是

手机号

idNo

String

否

证件号码

sex

Integer

否

性别：1男，2女

age

Integer

否

年龄

faceImageUrl

String

否

智能识别图片地址, OSS文件的KEY，参见1.8获取OSS上传连接的说明

返回结果

字段名

类型

备注

data

JSON

用户ID

用户ID

字段名

类型

备注

identityId

String

用户ID

faceId

String

用户ID

2.2修改用户

**Path

/solution/community/paas/user/update

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

identityId

String

是

用户ID

userName

String

否

用户名

idNo

String

否

证件号码

sex

Integer

否

性别：1男，2女

age

Integer

否

年龄

faceImageUrl

String

否

智能识别图片地址, OSS文件的KEY，参见1.6.7获取OSS上传连接的说明

返回结果

通用网关消息体，无业务字段

2.3用户组添加用户

**Path

/solution/community/paas/user/group/member/add

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

userGroupId

String

是

用户组ID

identityId

String

是

用户ID

返回结果

通用网关消息体，无业务字段

2.4用户组删除用户

**Path

/solution/community/paas/user/group/member/delete

请求方式

post

接口版本

1.0.0

请求参数

字段名

类型

必填

备注

userGroupId

String

是

用户组ID

identityId

String

是

用户ID

返回结果

通用网关消息体，无业务字段

  • 本页导读 （0）
文档反馈