Previous page

Next page

Locate page in Contents

Print this page

group_set_users

Summary:

Removes all members from the specified group and adds the specified members.

Request specification:

Name

Min/Max

Type

Description

group_set_users

0..[]

 

 

{

 

 

 

group

1..1

 

Parent group information.

{

 

 

 

name

1..1

string

The group name.

}

 

 

 

user

0..[]

 

Users to add to the parent group.

{

 

 

 

name

1..1

string

User name.

}

 

 

 

member_group

0..[]

 

Member groups to add to the parent group.

{

 

 

 

name

0..1

string

Group name.

}

 

 

 

}

 

 

 

Returns:

OK/Error

Description:

The call will first remove all users and member groups from the specified group (the users and the groups will not be deleted from the system). It will then add the specified users and (or) member groups to the parent group. To simply remove all members from a group without adding the new ones, do not include the user and the member_group parameters.

Example:

Removing the user TestUser from the group mynewgroup.

<packet version="4.0.0">

<dst>

<host>9bafbeb7-85f7-499e-a210-40e00850a5f3</host>

</dst>

<target>userm</target>

<data>

<userm>

<group_set_users>

<group>

<name>mynewgroup</name>

</group>

<user>

<name>TestUser</name>

</user>

</group_set_users>

</userm>

</data>

</packet>

Please send us your feedback on this help page