GroupMembershipControl 数据对象

GroupMembershipControl 用于 get API 和 update API 的输入数据对象中。

在 get API 中,GroupMembershipControl 用于请求某个实体所属于的组。如果 theGroupMembershipControl 已添加到输入数据对象,那么将返回实体所属于的组。GroupMembershipControl 还可用于指定要为组返回的属性以及要返回的嵌套组的级别。

由于 GroupMembershipControl 扩展自 SearchControl,因此您可以指定属性仅返回满足搜索标准的组。 例如,您可以添加一个值为“entities[@xsi:type='Group' and cn='Admin*']”的属性表达式,以仅返回其“cn”属性以“Admin”开始的组。

get API 中 GroupMembershipControl 数据对象的结构由以下内容组成:
properties
是您希望从与搜索标准匹配的实体中返回的属性的列表。例如,您希望获取位于市场营销部门的个人的 sn 和 givenName 属性。
searchBases
是一个搜索条件的列表,用于将搜索限制为列表中指定这些条件。
countLimit
指定由搜索操作返回的搜索结果的最大数量。
timeLimit
如果概要文件存储库支持 timeLimit,那么此属性指定搜索的最长持续时间(以毫秒为单位)。
expression
是 XPath 格式的搜索表达式。
level
用于指示要返回的嵌套组的级别。level 的缺省值为 1。请参阅下表。
此表汇总了 level 的可能值:
表 1. GroupMembershipControl 的 level 值
GroupMembershipControl level 描述
1(缺省值) 仅返回直接组。
0 返回所有嵌套组
update API 中 GroupMembershipControl 数据对象的结构由以下内容组成:
modifyMode
指定要使用分配、修改还是取消分配方式。请参阅下表。
此表汇总了 modifyMode 的可能值:
表 2. GroupMembershipControl 的 modifyMode 值
GroupMembershipControl modifyMode 描述
1(缺省值) 分配方式。实体数据对象中包含的组作为成员来添加实体。
2 替换方式。实体数据对象中包含的组作为成员来添加实体,并且将移除所有现有成员。
3 取消分配方式。实体数据对象中包含的组从其成员中移除实体。

XML 模式定义

以下是 GroupMembershipControl 的 XML 模式定义:
data object <xsd:complexType name="GroupMembershipControl">
		<xsd:complexContent>
			<xsd:extension base="GroupControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

样本数据对象

以下是 get API 中使用的一个样本 GroupMembershipControl 数据对象。该数据对象请求实体所属于的直接组 (level=1)。它还指示为组返回“cn”属性(如果该属性存在)。
<wim:controls xsi:type="wim:GroupMembershipControl" level="1">
      <wim:properties>cn</wim:properties>
      <wim:properties>displayName</wim:properties>
</wim:controls>
以下是 update API 中使用的一个样本 GroupMembershipControl 数据对象。该数据对象指示将从组中取消分配实体。
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>


使用条款 | 反馈