ACTIVE DIRECTORY Connect to Active Directory function

The ACTIVE DIRECTORY Connect to Active Directory function in RPA.

Help CentreBuilding Processes

This article describes the RPA Active Directory functionality to connect to an Active Directory server.

For a full list of available functions, please read ACTIVE DIRECTORY functions.


Description

The ACTIVE DIRECTORY Connect function establishes a connection to an Active Directory server using LDAP. This connection is required before performing any other Active Directory operations.


Setting it up

To use the ACTIVE DIRECTORY Connect function, follow these instructions:

{{popups:rpas/add:action=ad-connect}}

Once on a process map:

  1. Navigate to the process where you would like to add the ACTIVE DIRECTORY Connect function
  2. Click on the green button's drop-down (right side of the green button labelled "Process")
  3. On the menu that appears, click on the "+ Activity" item
  4. From here you can select the ACTIVE DIRECTORY Connect option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
NameYesText-A unique name for this connection, used to reference it in subsequent actions
HostYesText-The hostname or IP address of the Active Directory server
PortNoNumber389The LDAP port number
UsernameYesText-The bind DN, domain\user, or user@domain for authentication
Base DNYesText-The base distinguished name for LDAP operations (e.g. DC=example,DC=com)
Use SSLNoBooleanfalseWhether to use LDAPS (SSL/TLS) for the connection
Start TLSNoBooleanfalseWhether to upgrade the connection to TLS using StartTLS

Output variables

This action does not produce output variables.


Errors

ErrorDescription
Connection failedCould not establish a connection to the server
Authentication failedThe provided credentials are invalid
Server unreachableThe server could not be reached at the specified host and port

Tips

  • Use port 636 with Use SSL enabled for secure LDAPS connections
  • Store credentials in the Credential Vault for security

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.