GroupMemberControl is used in the input data object of both the get API and the update API.
In the get API, GroupMemberControl is used to request the members of a group. If the GroupMemberControl is added to the input data object, the members of the group are returned. GroupMemberControl can also be used to specify the properties to be returned for the members as well as the level of nested members to be returned.
Because GroupMemberControl is extended from SearchControl, you can specify properties to return only the groups that satisfy the search criteria. For example, you can add property expression with value: “entities[@xsi:type='PersonAccount']” to return only the members which are of PersonAccount entity type.
GroupMemberControl level | Description |
---|---|
1 (default) | Returns immediate members only. |
0 | Returns all nested members. |
GroupMemberControl modifyMode | Description |
---|---|
1 (default) | Assign Mode. The members contained in the group data object are added to this the group as a members. |
2 | Replace Mode. The members contained in the group data object are added to the group as its members and all the existing members of the group are removed. |
3 | Unassign Mode. The members contained in the group data object are removed from the group. |
<xsd:complexType name="GroupMemberControl">
<xsd:complexContent>
<xsd:extension base="GroupControl">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<wim:controls xsi:type="wim:GroupMemberControl" level="1">
<wim:properties>cn</wim:properties>
<wim:properties>uid</wim:properties>
<wim:properties>o</wim:properties>
<wim:properties>ou</wim:properties>
</wim:controls>
<wim:controls xsi:type="wim:GroupMemberControl" modifyMode="3"/>