Active Directory - Get group members |
Declaration
<AMACTIVEDIRECTORY ACTIVITY="get_group_members" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" GROUP="text" RESULTDATASET="text" />
Description
Retrieves all members of a specific Active Directory group and populates a dataset with the results.
Practical Usage
Allows an administrator to retrieve information about all members of a particular Active Directory group. Along with a Loop Dataset activity, subsequent Active Directory activities can be performed to rename, modify or delete one or more members.
Parameters
Group
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Parent path | Text | Yes | (Empty) | LDAPPATH="LDAP://DC=netauto,DC=com" | The LDAP (Lightweight Directory Access Protocol) path of the parent Active Directory container. This is usually the top most container or rootDSE path, the root of the directory data tree on a directory server. Click the Select Container button to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory container. |
Populate dataset with group members | Text | Yes | (Empty) | RESULTDATASET="myDataset" | The name of the dataset in which to populate the members of the chosen Active Directory group. More details regarding the fields that this dataset creates is entered below under Datasets. |
Credentials
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Authentication type | Text (options) | No | Default |
|
Specifies
the types of authentication used. The available options are:
|
Username | Text | No | (Empty) | USERNAME="username" | The
username context that this activity will execute under. Leave
the Username and Password parameters blank in
order to use the logon user's credentials NOTE: A Domain User has
permission to access Active Directory information. However, only
a Domain Administrator has permission to perform Active Directory
modifications. |
Password | Text | No | (Empty) | PASSWORD="password" | The password associated to the Username context that this activity will execute under. Leave the Username and Password parameters blank in order to use the logon user's credentials. |
Additional Notes
Datasets
A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (assuming the dataset name entered was theDataset):
Name | Type | Return Value |
---|---|---|
theDataset.MemberName | Text | Returns the Active Directory group member's username. |
theDataset.LDAPPath | Text | Returns the Active Directory group member's LDAP path. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
Get Members of Active Directory Group "LDAP://OU=TestCases,DC=mycompany,DC=com" and populate Automate Dataset "theGroupMembers."
<AMACTIVEDIRECTORY ACTIVITY="get_group_members" AUTHTYPE="Secure" USERNAME="UserName" PASSWORD="AM5XcDajItQUknoK1luekgmx/e7Putv9RG+TpVDRzIPAYE=aME" GROUP="LDAP://OU=TestCases,DC=mycompany,DC=com" RESULTDATASET="theGroupMembers" />