GroupMembershipControl は、get API と update API の両方の入力データ・オブジェクトで使用されます。
get API では、GroupMembershipControl は、エンティティーが属するグループを要求するために使用されます。 入力データ・オブジェクトに GroupMembershipControl を追加すると、エンティティーが属するグループが戻されます。 GroupMembershipControl はまた、グループについて戻すプロパティーのほか、戻すネストされたグループのレベルを指定するためにも使用できます。
GroupMembershipControl は SearchControl から拡張されるため、プロパティーを指定して、検索条件を満たすグループのみを戻すようにすることができます。 例えば、値「entities[@xsi:type='Group'and cn='Admin*']」を含むプロパティー expression を追加すれば、「cn」プロパティーが「Admin」で始まるグループのみを戻すことができます。
GroupMembershipControl level | 説明 |
---|---|
1 (デフォルト) | 直接のグループのみを戻します。 |
0 | ネストされたグループをすべて戻します。 |
GroupMembershipControl modifyMode | 説明 |
---|---|
1 (デフォルト) | 割り当てモード。 エンティティー・データ・オブジェクトに含まれているグループが、エンティティーをメンバーとして追加します。 |
2 | 置換モード。 エンティティー・データ・オブジェクトに含まれているグループが、エンティティーをメンバーとして追加し、既存のメンバーがすべて除去されます。 |
3 | 割り当て解除モード。 エンティティー・データ・オブジェクトに含まれているグループが、そのメンバーからエンティティーを除去します。 |
data object <xsd:complexType name="GroupMembershipControl">
<xsd:complexContent>
<xsd:extension base="GroupControl">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<wim:controls xsi:type="wim:GroupMembershipControl" level="1">
<wim:properties>cn</wim:properties>
<wim:properties>displayName</wim:properties>
</wim:controls>
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>