Previous page

Next page

Locate page in Contents

Print this page

add_to_group

Summary:

Add a user or a group to other groups as a member.

Request specification:

Name

Min/Max

Type

Description

add_to_group

1..1

auth_nameType

The inherited auth_nameType portion is used to specify the user/group to add to other groups as a member.

{

 

 

 

group

1..[]

auth_nameType

Parent groups. The specified user or group will be added as a member to these groups.

}

 

 

 

Returns:

OK/Errors.

Description:

The call adds a user or a group to another group or to multiple groups. This call works only with the users and groups that already exist. To create a new user or a group and add it to another group at the same time, use the add_user or add_group calls.

Example:

Adding a user Test_User from the default realm to the Administrators group.

Input

<packet version="4.0.0" id="2">

<target>authm</target>

<data>

<authm>

<add_to_group>

<name>VGVzdF9Vc2Vy</name>

<group>

<name>Q049QWRtaW5pc3RyYXRvcnMsQ049Um9sZXMsREM9U1dB</name>

</group>

</add_to_group>

</authm>

</data>

</packet>

Output

<packet id="15c446895a1t390c" version="4.0.0">

<origin>authm</origin>

<data>

<authm>

<ok/>

</authm>

</data>

</packet>

Please send us your feedback on this help page