"GroupMemberControl" wird im Eingabedatenobjekt der APIs "get" und "update" verwendet.
In der API "get" wird "GroupMemberControl" verwendet, um die Mitglieder einer Gruppe abzufragen. Wenn "GroupMemberControl" dem Eingabedatenobjekt hinzugefügt wird, werden die Mitglieder der Gruppe zurückgegeben. "GroupMemberControl" kann auch verwendet werden, um die Merkmale für die Mitglieder anzugeben, sowie die Ebene der verschachtelten Mitglieder, die zurückgegeben werden sollen.
Da "GroupMemberControl" eine Erweiterung von "SearchControl" ist, können Sie die Merkmale für die Rückgabe so festlegen, dass nur die Gruppen zurückgegeben werden, die die Suchkriterien erfüllen. Beispiel: Sie können das Merkmal "expression" mit dem Wert "entities[@xsi:type="PersonAccount"]" hinzufügen, so dass nur die Mitglieder zurückgeben werden, die den Entitätstyp "PersonAccount" besitzen.
Die Datengraphstruktur des Datenobjekts "GroupMemberControl" in der API "get" besteht aus Folgendem:
- properties
- Dies ist eine Liste der Attribute, die Sie von den Entitäten abrufen möchten und die mit den Suchkriterien
übereinstimmen sollen. Beispiel: Sie möchten die Attribute "sn" (Familienname) und "givenName" (Vorname) für eine bestimmte Person im Vertrieb abrufen.
- searchBases
- Eine Liste der verwendeten Suchbasen, um die Suche auf die in der Liste angegebenen Suchbasen zu beschränken.
- countLimit
- Gibt die maximale Anzahl von Suchergebnissen an, die durch die Suchoperation zurückgegeben werden sollen.
- timeLimit
- Wenn das Profil-Repository "timeLimit" unterstützt, gibt dieser Parameter die maximale Suchdauer in Millisekunden an.
- expression
- Ist der Suchausdruck im Format XPath.
- level
- Wird verwendet, um anzugeben, welche Hierarchieebene zurückgegeben werden soll.
In "GroupMemberControl" wird damit die Ebene der verschachtelten Mitglieder angegeben. Siehe auch die folgende Tabelle.
In dieser Tabelle werden die gültigen Werte für die Ebene dargestellt:
Tabelle 1. "GroupMemberControl" - Ebenen und Werte"GroupMemberControl"-Ebene |
Beschreibung |
1 (Standard) |
Gibt nur unmittelbare Mitglieder zurück. |
0 |
Gibt alle verschachtelten Mitglieder zurück. |
Die Datengraphstruktur des Datenobjekts "GroupMemberControl" in der API "update" besteht aus Folgendem:
- modifyMode
- Gibt die Verwendung der Modi "Assign" (Zuordnen), "Modify" (Ändern) oder "Unassign" (Zuordnung aufheben) an. Siehe auch die folgende Tabelle.
In dieser Tabelle werden die gültigen Werte von "modifyMode" zusammengefasst:
Tabelle 2. "GroupMemberControl" -
"modifyMode"-Werte"GroupMemberControl" "modifyMode" |
Beschreibung |
1 (Standard) |
Modus "Assign". Die Mitglieder des Datenobjekts "Group" werden dieser Gruppe als Mitglieder hinzugefügt. |
2 |
Modus "Replace". Die Mitglieder des Datenobjekts "Group" werden dieser Gruppe als Mitglieder hinzugefügt, und alle bereits vorhandenen Mitglieder der Gruppe werden entfernt. |
3 |
Modus "Unassign". Die Mitglieder des Datenobjekts "Group" werden aus der Gruppe entfernt. |
XML-Schemadefinition
Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "GroupMemberControl":
<xsd:complexType name="GroupMemberControl">
<xsd:complexContent>
<xsd:extension base="GroupControl">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Beispieldatenobjekte
Untenstehend finden Sie ein Beispiel für das Datenobjekt "GroupMemberControl" in der API "get". Es ruft die unmittelbaren Mitglieder der Gruppe ab (Ebene 1). Es gibt außerdem an, dass für die Mitglieder die Attribute "uid", "cn", "o" und "ou" zurückgegeben werden sollen, falls vorhanden.
<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>
Untenstehend finden Sie ein Beispiel für das Datenobjekt "GroupMemberControl" in der API "update". Es gibt an, dass für die Mitglieder der Gruppe die Zuordnung zu dieser aufgehoben werden soll.
<wim:controls xsi:type="wim:GroupMemberControl" modifyMode="3"/>