Help Centre › Building 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:
- Navigate to the process where you would like to add the ACTIVE DIRECTORY Connect function
- Click on the green button's drop-down (right side of the green button labelled "Process")
- On the menu that appears, click on the "+ Activity" item
- From here you can select the ACTIVE DIRECTORY Connect option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Name | Yes | Text | - | A unique name for this connection, used to reference it in subsequent actions |
| Host | Yes | Text | - | The hostname or IP address of the Active Directory server |
| Port | No | Number | 389 | The LDAP port number |
| Username | Yes | Text | - | The bind DN, domain\user, or user@domain for authentication |
| Base DN | Yes | Text | - | The base distinguished name for LDAP operations (e.g. DC=example,DC=com) |
| Use SSL | No | Boolean | false | Whether to use LDAPS (SSL/TLS) for the connection |
| Start TLS | No | Boolean | false | Whether to upgrade the connection to TLS using StartTLS |
Output variables
This action does not produce output variables.
Errors
| Error | Description |
|---|---|
| Connection failed | Could not establish a connection to the server |
| Authentication failed | The provided credentials are invalid |
| Server unreachable | The 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