用户组操作

获取用户组详情

userGroup.get(groupID)

参数说明

参数 类型 必填 说明
groupID integer Y 用户组 ID

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.get(123)
  4. }

返回示例

  1. {
  2.   "id": 47,
  3.   "members": 0,
  4.   "name": "User Group",
  5.   "parent": {
  6.     "id": 1,
  7.     "name": "Super Group"
  8.   }
  9. }

members 表示在用户组下的用户数量，parent 表示用户组的组集

获取用户组列表

userGroup.getUserGroupList({parentID})

参数说明

参数 类型 必填 说明
parentID integer N 用户组的组集 ID

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.offset(0).limit(20).getUserGroupList({parentID: '11'})
  4. }
  1. // 查询所有用户组
  2. userGroup.offset(0).limit(20).getUserGroupList({})

返回示例

  1. {
  2.   "meta": {"limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1},
  3.   "objects": [{
  4.     "id": 8,
  5.     "members": 6,
  6.     "name": "程序员",
  7.     "parent_id": null,
  8.     "super_group": {"id": null, "name": null}
  9.   }]
  10. }

创建用户组

userGroup.create({name,parent})

参数说明

参数 类型 必填 说明
name String Y 用户组的名称
parent integer N 组集 ID

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.create({name: '测试',parent:'11'})
  4. }

修改用户组

userGroup.update(groupID, {name})

参数说明

参数 类型 必填 说明
name String Y 用户组的名称
groupID integer Y 用户组 ID

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.update(12, {name: '888'})
  4. }

批量删除用户组

userGroup.delete([id,...])

参数说明

参数 类型 必填 说明
id integer Y 用户组 ID

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.delete([12, 13])
  4. }

将用户添加至用户组

userGroup.addUserIntoGroup(users, groups)

参数说明

参数 类型 必填 说明
users integer Array Y 用户 ID (对应 _userprofile 表中的 id 字段) 数组
groups integer Array Y 用户组 ID 数组

示例代码

  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.addUserIntoGroup([1092612, 1092601], [8, 9])
  4. }

将用户移除用户组

userGroup.removeUserFromGroup(users, groups)

参数说明

参数 类型 必填 说明
users integer Array Y 用户 ID (对应 _userprofile 表中的 id 字段) 数组
groups integer Array Y 用户组 ID 数组 
  1. exports.main = async function (event) {
  2.   let userGroup = new BaaS.UserGroup()
  3.   return await userGroup.removeUserFromGroup([1092612], [8, 9])
  4. }