"GroupMembershipControl" wird im Eingabedatenobjekt der APIs "get" und "update" verwendet.
In der API "get" wird "GroupMembershipControl" verwendet, um die Gruppen abzufragen, zu denen eine Entität gehört. Wenn "GroupMembershipControl" dem Eingabedatenobjekt hinzugefügt wird, werden die Gruppen, zu denen die Entität gehört,
zurückgegeben. "GroupMembershipControl" kann auch verwendet werden, um die Merkmale für die zurückzugebenden Gruppen sowie die Ebene der verschachtelten Gruppen anzugeben, die zurückgegeben werden sollen.
Da "GroupMembershipControl" 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='Group'
and cn='Admin*']" hinzufügen, so dass nur die Gruppen zurückgegeben werden, bei denen das Merkmal "cn" mit "Admin" beginnt.
Die Struktur des Datenobjekts "GroupMembershipControl" 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 Ebene der verschachtelten Gruppen zurückgegeben werden soll. Der Standardwert für die Eben ("level") ist 1. Siehe auch die folgende Tabelle.
In dieser Tabelle werden die gültigen Werte für die Ebene dargestellt:
Tabelle 1. "GroupMembershipControl" - Ebenen und Werte"GroupMembershipControl"-Ebene |
Beschreibung |
1 (Standard) |
Gibt nur unmittelbare Gruppen zurück. |
0 |
Gibt alle verschachtelten Gruppen zurück. |
Die Struktur des Datenobjekts "GroupMembershipControl" 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. "GroupMembershipControl" -
"modifyMode" und Werte"GroupMembershipControl" "modifyMode" |
Beschreibung |
1 (Standard) |
Modus "Assign". Die Gruppen, die im Entitätsdatenobjekt enthalten sind, nehmen die Entität als Mitglied auf. |
2 |
Modus "Replace". Die Gruppen, die im Entitätsdatenobjekt enthalten sind, nehmen die Entität als Mitglied auf, und alle bereits vorhandenen Mitglieder werden entfernt. |
3 |
Modus "Unassign". Die Gruppen, die im Entitätsdatenobjekt enthalten sind, entfernen die Entität aus den Mitgliedern. |
XML-Schemadefinition
Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "GroupMembershipControl":
data object <xsd:complexType name="GroupMembershipControl">
<xsd:complexContent>
<xsd:extension base="GroupControl">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Beispieldatenobjekte
Untenstehend finden Sie ein Beispiel für das Datenobjekt "GroupMembershipControl" in der API "get". Es ruft die unmittelbaren Gruppen (Ebene 1) ab, zu denen die Entität gehört. Es gibt außerdem an, dass für die Gruppen das Attribut "cn" zurückgegeben werden soll, falls das Attribut vorhanden ist.
<wim:controls xsi:type="wim:GroupMembershipControl" level="1">
<wim:properties>cn</wim:properties>
<wim:properties>displayName</wim:properties>
</wim:controls>
Untenstehend finden Sie ein Beispiel für das Datenobjekt "GroupMembershipControl" in der API "update". Es gibt an, dass für die Entität die Zuordnung zu diesen Gruppen aufgehoben werden soll.
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>