Active Directory Distribution List Member Retrieve Version 1

This handler will use the server information and user credentials configured in the task info values to authenticate and connect to the specified Active Directory server (using LDAP) and search for the distribution group on the search parameters provided. If Email Address is the 'search by' parameter, the handler looks for a '@' symbol in the User Logon to determine how to search for the User Logon name. A '@' symbol indicates a search for the LDAP attribute userPrincipalName (up to 100 characters) while the absence of the '@' symbol will result in a search for the LDAP attribute sAMAccountName (pre-Windows 2000).

  • If 'Distinguished Name' is selected, the 'distinguishedName' attribute will be used directly to retrieve the User objects that are a member of the provided group.

  • If 'Email Address' is selected, the Distinguished Name of the group will first be searched for by the mail address.

Parameters

Name Description
Search By Choose which attribute of the user to search by
Search Value The actual search expression to search for

Sample Configuration

Name Description
Search By Email Address
Search Value distributionlistname@acmecompany.com

Results

Name Description
Email Addresses The email addresses of all users in the group.

Changelog

Active Directory Distribution List Member Retrieve V1 (2014-03-17)

  • Initial version. See README for details.


Related Handlers

Active Directory Computer Add Groups
Finds a user in active directory by Distinguished Name and adds the computer as a member to one or more groups.
Active Directory Group Create
Creates an Active Directory group entry and uses the provided parameter values to specify common attributes. This handler will fail if the group already exists.
Active Directory User Add Groups
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Logon and adds the user as a member to one or more groups.
Active Directory User Change Attribute
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and changes the specified LDAP attribute.
Active Directory User Create
Creates an Active Directory user entry and uses the provided parameter values to specify common user attributes.
Active Directory User Disable
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and disables the user's account.
Active Directory User Enable
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and enables the user's account.
Active Directory User Expire Password
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and sets the password to expired, requiring the user to change it.
Active Directory User Permanent Password
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and sets the 'password never expires' flag.
Active Directory User Remove Groups
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Logon and remove that user as a member from one or more groups.
Active Directory User Retrieve
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and returns a predefined set of attributes to include the Distinguished Name(dn).
Active Directory User Temporal Password
Finds a user in active directory by Distinguished Name, Full Name, Email Address, or User Name and sets the 'password never expires' flag.