Using Alteryx to query Active Directory

[Data_is_mymiddlename]

Here are my instructions for using Alteryx to query Active Directory. We use Alteryx 2019.1 and this workflow was run against a Windows Server 2008 R2 AD instance. Your mileage may vary if your configuration is different.

Note: This is my first new thread post on the community, so please let me know if I missed something or need to make changes.

I am also working on a "group membership" workflow/macro. I hope to post those instructions in the near future.

Feel free to provide feedback (even grammar!).

Thank you.

How to add an Active Directory lookup to your Alteryx workflow

1. Add the Dynamic Input tool to your workflow. It can be found under the Developer tab.

2. Select the newly added Dynamic Input tool, then click Edit in the Configuration pane to add the Active Directory server and query information.

3. In the new Alteryx Designer x64 window, click the dropdown below Connect a File or Database and select Other Databases then OleDB…

4. Select OLE DB Provider for Microsoft Directory Services from Select the data you want to connect to: section in the Provider tab in the Data Link Properties window, then click Next >>.

5. On the Connection tab, enter the name of the Active Directory server in the Data Source: and Location: textboxes in section then select the Use Windows NT Integrated security radio button.

Note: Please use a local domain control for best performance. To see the local Windows PC’s currently connected domain controller, open Command Prompt (CMD.exe) and type SET. The information will be under the LOGONSERVER value. Be sure to add your domain name to the end if SET is used to find the domain controller.

6. Click Test Connection.

7. An error message will appear, but don’t worry. Now click Yes on the Microsoft Data Link Error window to continue with a test connection.

8. If a successful message (like the one below) does not appear, return to step 4 and check that everything was entered correctly, otherwise proceed to step 9.

9. Click OK to close the Data Link Properties

10. In the new Choose Table or Specify Query window, click the SQL Editor

Note: If you close this window, you will have to restart from step 3.

11. Decide on the desired SQL for your query:

• First, select desired attributes from the list below to output

For more attributes, check with your Active Directory Administrator or the Internet.

• Next, select attributes from the list above to use for the search
• Finally, combine output attributes, Active Directory server, and search attributes to create a SQL query:

SELECT (add desired attributes separated by a comma here)

from 'LDAP://(Active Directory Server)’

where (desired attribute search) = ‘test’

Note: The search criteria is ‘test’ because the Dynamic Input tool will replace ‘test’ with the actual results from a preceding tool in the workflow.

Here is an example where name, userid, and email would be returned from a local Active Directory Server with a search based on userid:

                SELECT cn, samaccountname, mail from 'LDAP://ADServer.domain.com’

WHERE samaccountname = 'test'

Here is a second example where name, title, supervisor name, supervisor userID, job hierarchy info, employee type, and office city would be returned from a local Active Directory Server with a search based on email address:

SELECT cn, title, ReportsToName, SupvID, division, employeeType, location from 'LDAP://ADServer.domain.com’ WHERE mail = 'test'

12. Click Test Query after entering the “SQL” to test the query.

13. If a successful message (like the one below) does not appear, return to step 11 and check that everything was entered correctly, otherwise proceed to step 14.
    

14. Click OK to close the Test Query Success

15. Click OK again to now close the Choose Table or Specify Query

16. Click OK one more time to now close the Alteryx Designer x64

17. Select the Dynamic Input tool, then select the Modify SQL Query radio button, click Add, and select SQL: Update WHERE Clause to open the SQL: Update WHERE Clause configuration window.

18. In the new SQL: Update WHERE Clause window, use the Replacement Field: dropdown, to select the field that will be used to provide the attribute used for searching. If you do not see anything in the Replacement Field: dropdown, confirm that the Dynamic Input tool is connected to the appropriate previous tool which has the desired replacement field.

Note: In this example, the mail attribute is being used for the search and so the email_address field from a previous tool in the workflow will be used to populate the search.

19. Click OK after confirming all information is correct in the SQL: Update WHERE Clause

20. Run the workflow!

21. Profit!

Additional information:

To modify your SQL query after completing step 19, follow the steps below:

I. Select the Dynamic Input tool then click Edit in the Input Data Source Template section

II. Click the … under option 4 in the Alteryx Designer x64

III. An error message like the one below will appear. Do not worry as this is normal and due to the way that Alteryx works. Click OK to close the Parsing Error

IV. Follow steps 10 through 16 above to enter and test the updated SQL query.

V. Continue through steps 17 through 19 if the attribute used in the WHERE clause was changed.

[HMSUM]

@Data_is_mymiddlename 

I tried following query to try get member with in user group but seems not working (return null), any idea how to query a matrix for all members within all group

# Query member within group

select cn, member from 'LDAP://[domain]' where objectclass='group'

# Query user and group belongs to 

select cn,memberof from 'LDAP://[domain]' where objectclass='user' and objectclass <> 'computer'

[ChrisTX]

@Data_is_mymiddlename do you have any tips or documentation based on your experience using AD Web Services to query Active Directory?

Chris

[F91]

here is the syntax in dynamic input, however, my task is to retireve all the users within the base domain

setting in input tools

[martman]

Hi Data

Hope you don't mind me using your middle name

I'm looking at your post using Alteryx to query Active Directory In using an input tool  to access  the AD which works fine but the lastlogon date for my account is null do you have any idea why?

Thanks

[Andrzej]

Hi,

I tried to establish connection, but in point 11 I keep getting this error. 

[FJ_Shafeek]

Is it possible to use this technique to read in the members of Active Directory groups?

[F91]

did u add OleDB??

fill in all the details then u should be able to connect

[sgwong]

Do u have any idea why certain field are not able to retrive e.g. pwdLastSet?

[sgwong]

Does anyone have idea why certain field are not able to retrive e.g. pwdLastSet?

[rajanikanthveluru]

I see date fields also we couldn't retrieve..