Active Directory - Get object dataset |
Declaration
<AMACTIVEDIRECTORY ACTIVITY="get_object_dataset" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" LDAPPATH="text" RESULTDATASET="text" />
Description
Creates a dataset that contains all the properties of the specified Active Directory object (i.e. user, group, computer, etc.). Each property of the object becomes a column of the dataset, with the first row containing the property value.
Practical Usage
Used to retrieve the properties of a specific Active Directory object. A Loop Dataset activity can be used in subsequent steps to loop through the properties.
Parameters
Object
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
LDAP path | Text | Yes | (Empty) | LDAPPATH=LDAP:// | The
Lightweight Directory Access Protocol (LDAP) path of the Active
Directory object to retrieve. The LDAP is an application protocol
for querying and modifying data of directory services implemented
in IP networks. Click the Select Object button to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory object. Click the Select Container button to select the parent container from the domain in which to select an Active Directory object from. |
Create and populate dataset | Text | Yes | (Empty) | RESULTDATASET="theDataset" | The name of the dataset to be created which will be populated with the Active Directory object's Property Name and Property Value. More on the field names that this dataset creates can be found 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 (rows):
Name | Type | Return Value |
---|---|---|
theDataset.PropertyName | Text | Returns the Active Directory Object's Property Name. |
theDataset.PropertyValue | Text | Returns the Active Directory Object's Property Value. |
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 properties of Active Directory object at ""LDAP://OU=MyCompany,DC=mycompany,DC=com"" and create and populate dataset "theDataset" with the properties.
<AMACTIVEDIRECTORY ACTIVITY="get_object_dataset" AUTHTYPE="Secure" USERNAME="UserName" PASSWORD="AM5Zj91Ik5l5ALazpGVjm1RnoeoNA7fU/SgIiNpxeFzaLk=aME" LDAPPATH="LDAP://OU=MyCompany,DC=mycompany,DC=com" RESULTDATASET="TheDataset" />