Administering group information

You can manage information that is associated with a group by using the administration API.

When a group is created in the user registry, you can set and get different pieces of information about the group. You must create a security context between the calling application and the Verify Identity Access policy server before you can access the user registry. You can obtain the user registry information for a group object by specifying either the Verify Identity Access group name or the user registry group name.

Table 1 lists the group information administration functions.

Table 1. Administering group attributes
Method Description
PDGroup constructor Instantiates a group object for the specified Verify Identity Access or user registry name.
PDGroup object.getDescription Returns the group description.
PDGroup object.getRgyName Returns the user registry name for the group.
PDGroup object.getId Returns the Verify Identity Access name for the group.
PDGroup object.isPDGroup Returns an indicator whether the object is a Verify Identity Access group.

PDGroup.setDescription
PDGroup object.setDescription

Sets a group description.
PDGroup object.getMembers Lists the members of a group.

PDGroup.addMembers
PDGroup object.addMembers

Adds users to a group.

PDGroup.removeMembers
PDGroup object.removeMembers

Removes users from a group.

For detailed reference information about these methods, see the Javadoc HTML documentation.