Skip to main content
Kinetic Community

Active Directory User Retrieve

Retrieves a user based on Distinguished Name, Full Name, User Logon, or Email Address. This handler will fail if the user is not found, or if more than one result is found.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

active_directory_user_retrieve_v3.zip

Detailed Description

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 user based on the search parameters provided.  If User Logon 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 entry.
* If 'Full Name' is selected, the 'cn' attribute will be used to retrieve the User entry.
* If 'User Name' is selected, the 'userprincipalname' value will be used if the "Search Value" parameter includes an '@' sign (IE john.doe@domain.com) and the 'samaccountname' will be used if it does not (IE john.doe).
* If 'Email Address' is selected, the 'mail' attribute will be used to retrieve the User entry.
 
This handler will fail if the user is not found, or if more than one     result is found.
 

Parameters

Name Description
Search By 'Dinstinguished Name', 'Full Name', 'User Logon', or 'Email Address'
Search Value
    The value of the Distinguished Name, Full Name, User Logon, or Email
    Address to search for

Sample Configuration

Parameter Example Configuration
Search By::  User Logon
Search Value::   <%=@answers['ReqFor Login ID']%>

Results

Name Description
First Name::   The first name of the user
Last Name:: The last name of the user
Full Name:: The Full Name of the user
Manager DN:: The DN of the user's Manager
Distinguished Name::
The globally-unique text string for this user in Active Directory
Initials:: The initials of the user
Description:: User description field
Office:: The string representing the office location
Telephone:: The primary telephone of the user
Email Address:: The email address of the user
User Logon:: The user logon name
User Principal Name:: The User Principal name
Account Enabled:: True or False, whether the account is enabled.
Title:: The users job title
Department:: The primary department of the user
Company:: The name of the users company

Change Log

Version Date Description
V1 2011-01-17 Initial Value
V2 2014-08-05 Changed the password info value to be encrypted.
V3 2015-08-03 Added ability to return if account is enabled.