GroupMembershipControl DataObject

GroupMembershipControl は、get API と update API の両方の入力データ・オブジェクトで使用されます。

get API では、GroupMembershipControl は、エンティティーが属するグループを要求するために使用されます。 入力データ・オブジェクトに GroupMembershipControl を追加すると、エンティティーが属するグループが戻されます。 GroupMembershipControl はまた、グループについて戻すプロパティーのほか、戻すネストされたグループのレベルを指定するためにも使用できます。

GroupMembershipControl は SearchControl から拡張されるため、プロパティーを指定して、検索条件を満たすグループのみを戻すようにすることができます。 例えば、値「entities[@xsi:type='Group'and cn='Admin*']」を含むプロパティー expression を追加すれば、「cn」プロパティーが「Admin」で始まるグループのみを戻すことができます。

get API での GroupMembershipControl DataObject の構造は、以下のものから構成されます。
プロパティー
検索条件を満たすエンティティーから戻す属性のリストです。 例えば、マーケティング部門に所属する個人の sn および givenName 属性を取得できます。
searchBases
検索を制限するために使用される検索ベースのリストです。検索は、このリストに指定されたベースに制限されます。
countLimit
検索操作で戻される検索結果の最大数を指定します。
timeLimit
検索の最長継続時間をミリ秒で指定します (プロファイル・リポジトリーが timeLimit をサポートしている場合)。
expression
XPath 形式の検索式です。
level
戻すネストされたグループのレベルを指定するために使用されます。 level のデフォルト値は 1 です。次の表を参照してください。
次の表は、level に有効な値を要約したものです。
表 1. GroupMembershipControl level の値
GroupMembershipControl level 説明
1 (デフォルト) 直接のグループのみを戻します。
0 ネストされたグループをすべて戻します。
update API での GroupMembershipControl DataObject の構造は、以下のものから構成されます。
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 DataObject のサンプルを示します。 これは、エンティティーが属する直接グループ (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 DataObject のサンプルを示します。 これは、エンティティーをグループから割り当て解除するように指定しています。
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>


利用条件 | フィードバック