Active Directory Module Steps

Overview

Prerequisite Features:

The Active Directory Module has to be installed. To learn how to install a module, see Installing Modules.
Set up of an Active Directory server is required. To learn more, see Integrating Active Directory with Decisions and Setting up Active Directory (AD) Server Authentication.

The Active Directory module introduces new Flow steps that allow users to build Flows centered around managing the Active Directory such as creating users, groups, associations, and more.

Commonly Used Active Directory Steps

All steps added by the Active Directory module are found within its eponymous folder in the Integration section of the Toolbox.

Location	Step Name	Description	Inputs/Outputs
Users	Find User By SAMAccount Name	The Find User By SAMAccount Name step connects to the Active Directory by configuring the Connection String Input and searches for the provided account via the SAMAccount Name Input. It then outputs the found account's information.	Inputs: Connection Settings (ADStepSettings), SAMAccount Name (String)
Outputs: Output (ADUser)
Find User By SAMAccount Name JSON	The Find User By SAMAccount Name JSON step connects to the Active Directory by configuring the Connection String Input and searches for the provided account via the SAMAccount Name Input. It then outputs the found account's information in a JSON string.	Inputs: Connection Strings (ADStepSettings), SAMAccount Name (String)
Outputs: Output (String)
Get All Users	The Get All Users step connects to the Active Directory by configuring the Connection Strings Input and then outputs a list of all found Active Directory users.	Inputs: Connection Strings (ADStepSettings)
Outputs: Output (ADUser[])
Set New Password	The Set New Password step finds the specified user name then changes it's password to the value of the New Password Input. If an error occurs on this step, it then outputs an error message.	Inputs: New Password (String), User Name (String)
Outputs: Error Message (String)
Root	Disable User	The Disable User step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. It then disables the user matching the login of the Login Name Input thus preventing them from logging into the server until reenabled.	Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)
Outputs: None
Enable User	The Enable User step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. It then enables the user matching the login of the Login Name Input thus allow them to log back into the server again.	Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)
Outputs: None
Get Groups List	The Get Group List step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. The Ou Path Input prompts which Organization Unit the step will search for groups if at all. It then outputs the list of found groups.	Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)
Output: Output (String[])
List Users In OU	The List Users In OU connects to the Active Directory by configuring the Connection String Input	Inputs: Connection Strings (ADStepSettings), Limit (Int32), OU (String)
Outputs: Output (ADUser[])
Find Computer By Name	The Find Computer By Namestep connects to the Active Directory by configuring the Connection String Input and then searches for a computer matching the Computer Name Input. It then outputs the found computer's information.	Inputs: Computer Name (String), Connection Settings (ADStepSettings)
Outputs: Output (ADComputer)
Find Computers By Name	The Find Computer By Name step connects to the Active Directory by configuring the Connection String Input and then searches computers matching the Computer Name Input. It then outputs the found computer's information.	Inputs: Computer Name (String), Connection Settings (ADStepSettings)
Outputs: Output (ADComputer[])
Find Group By Name	The Find Group By Name step connects to the Active Directory by configuring the Connection String Input and then searches for the group matching the Group Name Input. It then outputs the found group's information.	Inputs: Connection Settings (ADStepSettings), Group Name (String)
Outputs: Output (ADGroup)
Find Groups By Name	The Find Groups By Namestep connects to the Active Directory by configuring the Connection String Input and then searches for the groups matching the Group Name Input. It then outputs the found groups' information.	Inputs: Connection Settings (ADStepSettings), Group Name (String)
Outputs: Output (ADGroup[])
List Computers In Active Directory	The List Computers In Active Directory step connects to the Active Directory by configuring the Connection String Input. It then outputs a list of all computers along with their information within the Active Directory.	Inputs: Connection Strings (ADStepSettings)
Outputs: Output (ADComputer[])
List Groups In Active Directory	The List Groups In Active Directory step connects to the Server IP Input with the specified User Name and Password aka Pwd Inputs. It then outputs a list of all groups along with their information within the server.	Inputs: Pwd (String), Server Ip (String), User Name (String)
Outputs: Output (ADGroup[])

Location

Step Name

Description

Inputs/Outputs

Users

Find User By SAMAccount Name

The Find User By SAMAccount Name step connects to the Active Directory by configuring the Connection String Input and searches for the provided account via the SAMAccount Name Input. It then outputs the found account's information.

Inputs: Connection Settings (ADStepSettings), SAMAccount Name (String)

Outputs: Output (ADUser)

Find User By SAMAccount Name JSON

The Find User By SAMAccount Name JSON step connects to the Active Directory by configuring the Connection String Input and searches for the provided account via the SAMAccount Name Input. It then outputs the found account's information in a JSON string.

Inputs: Connection Strings (ADStepSettings), SAMAccount Name (String)

Outputs: Output (String)

Get All Users

The Get All Users step connects to the Active Directory by configuring the Connection Strings Input and then outputs a list of all found Active Directory users.

Inputs: Connection Strings (ADStepSettings)

Outputs: Output (ADUser[])

Set New Password

The Set New Password step finds the specified user name then changes it's password to the value of the New Password Input. If an error occurs on this step, it then outputs an error message.

Inputs: New Password (String), User Name (String)

Outputs: Error Message (String)

Root

Disable User

The Disable User step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. It then disables the user matching the login of the Login Name Input thus preventing them from logging into the server until reenabled.

Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)

Outputs: None

Enable User

The Enable User step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. It then enables the user matching the login of the Login Name Input thus allow them to log back into the server again.

Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)

Outputs: None

Get Groups List

The Get Group List step connects to the LDAP server by configuring its System User Name. System Password, and LDAP Server Address Inputs. The Ou Path Input prompts which Organization Unit the step will search for groups if at all. It then outputs the list of found groups.

Inputs: System User Name (String), System Password (String). LDAP Server Address (String), Login Name (String)

Output: Output (String[])

List Users In OU

The List Users In OU connects to the Active Directory by configuring the Connection String Input

Inputs: Connection Strings (ADStepSettings), Limit (Int32), OU (String)

Outputs: Output (ADUser[])

Find Computer By Name

The Find Computer By Namestep connects to the Active Directory by configuring the Connection String Input and then searches for a computer matching the Computer Name Input. It then outputs the found computer's information.

Inputs: Computer Name (String), Connection Settings (ADStepSettings)

Outputs: Output (ADComputer)

Find Computers By Name

The Find Computer By Name step connects to the Active Directory by configuring the Connection String Input and then searches computers matching the Computer Name Input. It then outputs the found computer's information.

Inputs: Computer Name (String), Connection Settings (ADStepSettings)

Outputs: Output (ADComputer[])

Find Group By Name

The Find Group By Name step connects to the Active Directory by configuring the Connection String Input and then searches for the group matching the Group Name Input. It then outputs the found group's information.

Inputs: Connection Settings (ADStepSettings), Group Name (String)

Outputs: Output (ADGroup)

Find Groups By Name

The Find Groups By Namestep connects to the Active Directory by configuring the Connection String Input and then searches for the groups matching the Group Name Input. It then outputs the found groups' information.

Inputs: Connection Settings (ADStepSettings), Group Name (String)

Outputs: Output (ADGroup[])

List Computers In Active Directory

The List Computers In Active Directory step connects to the Active Directory by configuring the Connection String Input. It then outputs a list of all computers along with their information within the Active Directory.

Inputs: Connection Strings (ADStepSettings)

Outputs: Output (ADComputer[])

List Groups In Active Directory

The List Groups In Active Directory step connects to the Server IP Input with the specified User Name and Password aka Pwd Inputs. It then outputs a list of all groups along with their information within the server.

Inputs: Pwd (String), Server Ip (String), User Name (String)

Outputs: Output (ADGroup[])

Active Directory Internal Services Steps

While not added with the Active Directory module's installation, the following commonly used pre-built steps streamline or otherwise assist with Active Directory configurations. To view the full list of these steps, navigate to the Toolbox location mentioned below.

Location	Step Name	Description	Inputs/Outputs
Internal Services > ActiveDirectoryServices	GetActiveDirectorySettings	The GetActiveDirectorySettings step automatically gathers the current configuration of the installed Active Directory module's settings and then output them. This output may be mapped to Active Directory steps needing connection string Inputs to save time over manually entering them.	Inputs: None
Outputs: Output (ActiveDirectorySettings)
TestLogin	The TestLogin step creates a test login user account for the Active Directory server often used to test connections. It then outputs the results of the login test.	Inputs: Domain and User Name (String), Password (String)
Outputs: Output (ActiveDirectoryLoginTestResult)

Location

Step Name

Description

Inputs/Outputs

Internal Services > ActiveDirectoryServices

GetActiveDirectorySettings

The GetActiveDirectorySettings step automatically gathers the current configuration of the installed Active Directory module's settings and then output them. This output may be mapped to Active Directory steps needing connection string Inputs to save time over manually entering them.

Inputs: None

Outputs: Output (ActiveDirectorySettings)

TestLogin

The TestLogin step creates a test login user account for the Active Directory server often used to test connections. It then outputs the results of the login test.

Inputs: Domain and User Name (String), Password (String)

Outputs: Output (ActiveDirectoryLoginTestResult)

Active Directory Module Steps

Overview

Commonly Used Active Directory Steps

Active Directory Internal Services Steps

What's Next