Summary

The overview of this document is as follows: This document introduces the API definitions of Fx.usergroup, usage methods, and related notes.

1. queryGroupByName Fuzzy search for user group list by name

Fx.userGroup.queryGroupByName(<string name>, <integer status>)

Request parameters

Request Body

Parameter Name	object	Description	Required
name	string	Fuzzy search username	Y
status	integer	User group status //0: Enabled, 1: Disabled	Y

Code examples

String name = "hb"
int status = 0
def(boolean error, List data, String message) = Fx.userGroup.queryGroupByName(name, status)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

2. queryGroupMembers Retrieve user IDs under a specified user group by its group ID

Retrieve user IDs under a user group by group ID

Fx.userGroup.queryGroupMembers()

Code examples

List groupIdList = ["63bf8075028c7a0001058fc4"]
def(boolean error, Map data, String message) = Fx.userGroup.queryGroupMembers(groupIdList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

Owner：张佳鑫ZhangJiaxin(已停用)

3. insertGroupMem Add members to user group

Add Group Members to User Group

Fx.userGroup.insertGroupMem()

Code examples

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.insertGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

Owner：张佳鑫ZhangJiaxin(已停用)

4. updateGroupMem Update Group Members

Update group members

Fx.userGroup.updateGroupMem()

Code examples

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1000","1001","1003","1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.updateGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

Owner：张佳鑫ZhangJiaxin(已停用)

5. deleteGroupMem Remove Group Members

User Group Remove Member

Fx.userGroup.deleteGroupMem()

Code examples

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.deleteGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

Owner：张佳鑫ZhangJiaxin(已停用)

Changelog

Version	Date	Changes	Author
v1.0	2026-05-20	Initial version

Background

This document provides detailed information about the Fx.userGroup API functionality and usage, helping developers integrate relevant capabilities.

Applicable Scenarios

Specific applicable scenarios are determined by actual business needs. Developers can select the appropriate API for integration as required.

Prerequisites

• Access to Fxiaoke Open Platform
• Application authorization and configuration completed
• Basic knowledge of relevant business domain

Steps

Please refer to the detailed instructions for each API.

Notes

• Ensure prerequisites are met before calling APIs
• Pay attention to API call frequency limits
• Refer to error code documentation for exception handling

Compatibility note: This version currently has no deprecated or compatibility notes.