Express (Distributed operating systems), v8.0 > Secure applications and their environment > Authenticate users > Select a registry or repository > Manage realms in a federated repository > Virtual member manager > Reference > Program model > Control DataObject


CheckGroupMembershipControl DataObject

CheckGroupMembershipControl verifies whether a group contains a specific member.

Use CheckGroupMemberShipControl to issue a get call specifying one group and a single member. Virtual member manager searches the underlying repository and returns a boolean value in the control of the return data object to indicate the membership relationship.

The structure of as CheckGroupMembershipControl data object consists of:

inGroup

indicates the result in the return data object after verifying the group member relationship. This is a boolean value. The default value is false.

level

specifies the level to be returned. The default value for the level is 1. See the following table.

This table summaries the possible values of the CheckGroupMembershipControl level:

CheckGroupMembershipControl level values

CheckGroupMembershipControl level Description
1 (default) Returns immediate members only.
0 Returns all nested members.


XML schema definition

The following is the XML schema definition for the CheckGroupMembershipControl DataObject:

<xsd:complexType name="CheckGroupMembershipControl">
<xsd:complexContent>
<xsd:extension base="Control">
<xsd:attribute name="level" type="xsd:int" default="1" />
<xsd:attribute name="inGroup" type="xsd:boolean" default="false" />
</xsd:extension>
</xsd:complexContent>
</xsd:complexType> 


Sample data object

The following is a sample CheckGroupMembershipControl data object used for a get method.

<wim:controls xsi:type="wim:CheckGroupMembershipControl" level="1"/> 
If the member is found in the group the return data object contains the control:
<wim:controls xsi:type="wim:CheckGroupMembershipControl" level="1" inGroup="true"/> 
If the member is not found in the group the value for inGroup is false.

Parent topic: Control DataObject



+

Search Tips   |   Advanced Search