GetGroup

Returns an Active Directory group object with all of its related Centrify-specific data.

Syntax

IGroup GetGroup(IADs group)

Parameter

Specify the following parameter when using this method:

Parameter Description

group

The IADs interface to the group object you want to retrieve. You can use the standard ADSI GetObject function to retrieve this interface.

Return value

The group object as:

Centrify.DirectControl.API.IGroup

Discussion

This method uses the IADs interface to locate the group object. The IADs interface is the directory object that represents the group in Active Directory. The IADs object is useful for retrieving Active Directory-specific information, such as the site, for a group.

The method returns the group object as Centrify.DirectControl.API.IGroup. You can then use the IGroup object to retrieve Centrify-specific information. For example, you can use IGroup.UnixProfiles to retrieve the UNIX group profiles associated with an Active Directory group or IGroup.AddUnixProfile to add a UNIX group profile for an Active Directory group to the zone.

Exceptions

GetGroup throws an ArgumentException if the parameter is null or empty.

Example

The following code sample illustrates using this method in a script:

...
'Specify the zone you want to work with
set objZone = cims.GetZone("ajax.org/UNIX/Zones/east_div”)
'Identify the Active Directory group you want to work with
set objIADsGroup = GetObject(“LDAP://CN=IT Interns,CN=Users, DC=ajax,DC=org”)
'Get the directory object for the group
set objGroup = cims.GetGroup(objIADsGroup)
...