GroupMembershipControl DataObject

GroupMembershipControl se utiliza en el objeto de datos de entrada tanto de la API de obtención (get) como de la API de actualización (update).

En la API de obtención (get), GroupMembershipControl se utiliza para solicitar los grupos a los que pertenece una entidad. Si theGroupMembershipControl se añade al objeto de datos de entrada, se devuelven los grupos a los que pertenece la entidad. GroupMembershipControl también se puede utilizar para especificar las propiedades que se devolverán para los grupos así como el nivel de los grupos anidados que se devolverá.

Debido a que GroupMembershipControl se extiende desde SearchControl, puede especificar propiedades para devolver únicamente los grupos que cumplan los criterios de búsqueda. Por ejemplo, puede añadir una expresión de propiedad con el valor: “entities[@xsi:type='Group' and cn='Admin*']” para devolver únicamente los grupos cuya propiedad “cn” empiece por “Admin”.

La estructura de un objeto de datos GroupMembershipControl en la API de obtención (get) está formada por los elementos siguientes:
properties
es una lista de los atributos que desea que se devuelvan de las entidades que coinciden con los criterios de búsqueda. Por ejemplo, desea obtener los atributos sn y givenName de las personas que están en el departamento de marketing.
searchBases
es una lista de las bases de búsqueda que se utilizan para limitar la búsqueda a las bases especificadas en la lista.
countLimit
especifica el número máximo de resultados de la búsqueda devueltos por la operación de búsqueda.
timeLimit
Si el depósito del perfil da soporte a timeLimit, especifica en milisegundos la duración máxima de la búsqueda.
expression
es la expresión de búsqueda en formato XPath.
level
se utiliza para indicar el nivel de los grupos anidados que se debe devolver. El valor predeterminado para el nivel el 1. Consulte la tabla siguiente.
Esta tabla resume los valores posibles del nivel:
Tabla 1. Valores de nivel de GroupMembershipControl
Nivel de GroupMembershipControl Descripción
1 (valor predeterminado) Sólo devuelve grupos inmediatos.
0 Devuelve todos los grupos anidados
La estructura de un objeto de datos GroupMembershipControl en la API de actualización (update) está formada por los elementos siguientes:
modifyMode
especifica el uso de la modalidad de asignación, modificación o desasignación. Consulte la tabla siguiente.
Esta tabla resume los valores posibles de modifyMode:
Tabla 2. Valores de GroupMembershipControl modifyMode
GroupMembershipControl modifyMode Descripción
1 (valor predeterminado) Modalidad de asignación. Los grupos contenidos en el objeto de datos de entidad añaden la entidad como un miembro.
2 Modalidad de sustitución. Los grupos contenidos en el objeto de datos de entidad añaden la entidad como un miembro y se eliminan todos los miembros existentes.
3 Modalidad de desasignación. Los grupos contenidos en el objeto de datos de entidad eliminan la entidad de sus miembros.

Definición de esquema XML

A continuación se proporciona la definición del esquema XML para GroupMembershipControl:
data object <xsd:complexType name="GroupMembershipControl">
		<xsd:complexContent>
			<xsd:extension base="GroupControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

Objetos de datos de ejemplo

A continuación se proporciona un GroupMembershipControl DataObject de ejemplo que se utiliza en la API de obtención (get). Solicita los grupos inmediatos (nivel=1) a los que pertenece la entidad. También indica que se devuelva el atributo “cn” para los grupos, si existe el atributo.
<wim:controls xsi:type="wim:GroupMembershipControl" level="1">
      <wim:properties>cn</wim:properties>
      <wim:properties>displayName</wim:properties>
</wim:controls>
A continuación se proporciona un GroupMembershipControl DataObject de ejemplo que se utiliza en la API de actualización (update). Indica que la entidad debe desasignarse de los grupos.
<wim:controls xsi:type="wim:GroupMembershipControl" modifyMode="3"/>


Condiciones de uso | Comentarios