GroupMemberControl DataObject

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

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

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

get API での GroupMemberControl DataObject のデータ・グラフ構造は、以下のものから構成されます。
プロパティー
検索条件を満たすエンティティーから戻す属性のリストです。 例えば、マーケティング部門に所属する個人の sn および givenName 属性を取得できます。
searchBases
検索を制限するために使用される検索ベースのリストです。検索は、このリストに指定されたベースに制限されます。
countLimit
検索操作で戻される検索結果の最大数を指定するために使用されます。
timeLimit
検索の最長継続時間をミリ秒で指定します (プロファイル・リポジトリーが timeLimit をサポートしている場合)。
expression
XPath 形式の検索式です。
level
戻す階層のレベルを指定するために使用されます。 GroupMemberControl では、ネストされたメンバーのレベルを指定します。 次の表を参照してください。
次の表は、level に有効な値を要約したものです。
表 1. GroupMemberControl level の値
GroupMemberControl level 説明
1 (デフォルト) 直接のメンバーのみを戻します。
0 ネストされたメンバーをすべて戻します。
update API での GroupMemberControl DataObject のデータ・グラフ構造は、以下のものから構成されます。
modifyMode
割り当て、変更、または割り当て解除モードを使用することを指定します。 次の表を参照してください。
次の表は、modifyMode に有効な値を要約したものです。
表 2. GroupMemberControl modifyMode の値
GroupMemberControl modifyMode 説明
1 (デフォルト) 割り当てモード。 グループ・データ・オブジェクトに含まれているメンバーが、グループにメンバーとして追加されます。
2 置換モード。 グループ・データ・オブジェクトに含まれているメンバーが、グループのメンバーとしてグループに追加され、グループの既存のメンバーがすべて除去されます。
3 割り当て解除モード。 グループ・データ・オブジェクトに含まれているメンバーが、グループから除去されます。

XML スキーマ定義

次に、GroupMemberControl DataObject の XML スキーマ定義を示します。
<xsd:complexType name="GroupMemberControl">
    <xsd:complexContent>
	 <xsd:extension base="GroupControl">
	 </xsd:extension>
    </xsd:complexContent>
	</xsd:complexType>

サンプル・データ・オブジェクト

次に、get API で使用される GroupMemberControl DataObject のサンプルを示します。 これは、グループの直接メンバー (level=1) を要求しています。 また、メンバーの uid、cn、o、および ou 属性 (存在する場合) を戻すことを指定しています。
    <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>
次に、update API で使用される GroupMemberControl DataObject のサンプルを示します。 これは、メンバーをグループから割り当て解除するように指定しています。
<wim:controls xsi:type="wim:GroupMemberControl" modifyMode="3"/>


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