GroupMembershipControl DataObject

GroupMembershipControl est utilisé dans l'objet de données d'entrée de l'API d'extraction (get) et de mise à jour (update).

Dans l'interface de programme d'application d'extraction, GroupMembershipControl permet de lancer une requête sur les groupes auxquels appartient une entité. Si vous ajoutez GroupMembershipControl à l'objet de données d'entrée, les groupes auxquels appartient l'entité sont renvoyés. GroupMembershipControl permet également d'indiquer les propriétés des groupes à renvoyer ainsi que le niveau des groupes imbriqués à renvoyer.

GroupMembershipControl étant une extension de SearchControl, vous pouvez indiquer les propriétés afin d'obtenir uniquement les groupes qui répondent aux critères de recherche. Par exemple, vous pouvez ajouter une expression de propriété avec la valeur : "entités[@xsi:type='Groupe' et cn='Admin*']" pour renvoyer uniquement les groupes dont les propriétés "cn" commencent par "Admin".

La structure d'un objet de données GroupMembershipControl dans l'interface de programme d'application d'extraction se compose des éléments suivants :
propriétés
liste des attributs à renvoyer des entités qui répondent aux critères de recherche. Par exemple, vous souhaitez obtenir les attributs sn et givenName des personnes du service marketing.
searchBases
liste de bases de recherche permettant de limiter la recherche aux bases recensées.
countLimit
nombre maximal de résultats renvoyés par l'opération de recherche.
timeLimit
Si le référentiel de profil prend en charge le délai, il indique la durée maximale de recherche en milliseconde.
expression
expression de recherche au format XPath.
level
permet d'indiquer le niveau des groupes imbriqués à renvoyer. Par défaut, la valeur de niveau est définie sur 1. Voir le tableau suivant.
Ce tableau répertorie les valeurs possibles du niveau :
Tableau 1. Valeurs de niveau GroupMembershipControl
Niveau GroupMembershipControl Description
1 (par défaut) Renvoie les groupes immédiats uniquement.
0 Renvoie tous les groupes imbriqués
La structure d'un objet de données GroupMembershipControl dans l'interface de programme d'application de mise à jour se compose des éléments suivants :
modifyMode
indique s'il faut utiliser le mode d'affectation, de modification ou de non affectation. Voir le tableau suivant.
Ce tableau répertorie les valeurs possibles de modifyMode :
Tableau 2. Valeurs modifyMode de GroupMembershipControl
GroupMembershipControl modifyMode Description
1 (par défaut) Mode affectation. Les groupes contenus dans l'objet de données d'entité ajoutent l'entité en tant que membre.
2 Mode remplacement. Les groupes contenus dans l'objet de données d'entité ajoutent l'entité en tant que membre et tous les membres existants sont supprimés.
3 Mode non affectation. Les groupes contenus dans l'objet de données d'entité suppriment l'entité de leurs membres.

Définition de schéma XML

Vous trouverez ci-dessous la définition du schéma XML pour l'objet de données GroupMembershipControl :
data object <xsd:complexType name="GroupMembershipControl">
		<xsd:complexContent>
			<xsd:extension base="GroupControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

Objet de données exemple

Voici un exemple d'objet de données GroupMembershipControl utilisé dans l'interface de programme d'application d'extraction. Il lance une requête sur les groupes immédiats (niveau=1) auxquels appartient l'entité. Il indique également qu'il faut renvoyer l'attribut "cn" des groupes, le cas échéant.
<wim:controls xsi:type="wim:GroupMembershipControl" level="1">
      <wim:properties>cn</wim:properties>
      <wim:properties>displayName</wim:properties>
</wim:controls>
Voici un exemple d'objet de données GroupMembershipControl utilisé dans l'interface de programme d'application de mise à jour. Il indique que l'entité doit être libérée de son affectation aux groupes.
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>


Conditions d'utilisation | Commentaires