Add UiPath Connector
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Tokens,Connectors
Creates a new UiPath connector in a connector group. The connector stores the UiPath tenant, username and password that Run Robot uses to sign in to UiPath. The action can save the ID of the new connector in a token, so later actions can test, use or update it.
The password is saved encrypted.
This action requires the UiPath feature to be licensed. UiPath support is a separate add-on package (DnnSharp.UiPath). If you don't see the UiPath actions, the add-on isn't installed.
Typical Use Cases
- Let each customer or department save its own UiPath account from a form
- Create UiPath connectors from a setup workflow instead of by hand
- Save the new connector's ID so you can test it or update it later
Don't use it to
- Change an existing UiPath connector. Use Update UiPath Connector instead.
- Check that the login details work. The action saves them without contacting UiPath. Use Test Connector after saving.
- Add a connector of another type. Use Add Connector instead.
Related Actions
| Action Name | Description |
|---|---|
| Update UiPath Connector | Changes the details of an existing UiPath connector. |
| Find Group | Gets a group ID from a group title and portal. |
| Test Connector | Checks that a connector can sign in. |
| Get Connector | Reads the details of a connector. |
| Delete Connector | Removes a connector. |
| Run Robot | Starts UiPath robot jobs using a UiPath connector. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Portal | The portal of the connector group. Leave it empty for global groups (not bound to a portal). It's only used to pick the group in the editor. When using an expression, the value must be the PortalId. | Yes | empty string | No |
| Group Title | The UiPath connector group to add the connector to. The list shows UiPath groups only. When using an expression, the value must be the GroupId. Use Find Group to get a GroupId from a group title and portal. | Yes | empty string | Yes |
| User Id | A user ID for the connector. In 1.28 this value isn't saved on the connector. | Yes | empty string | No |
| Entry title | The name of the connector, for example UiPath - [CompanyName]. | Yes | empty string | No |
| Tenant Name | The UiPath tenant name to sign in to. | Yes | empty string | No |
| Username or Email | The UiPath username or email address. | Yes | empty string | No |
| Password | The UiPath password. Saved encrypted. | Yes | empty string | No |
| EntryId Token Name | The name of a token to save the new connector's ID in, for example UiPathConnectorId. Brackets are optional. | No | empty string | No |
Output Parameters Reference
| Parameter | Description |
|---|---|
[<EntryId Token Name>] | The ID of the new connector, a GUID. It's only set when EntryId Token Name has a value. |
Considerations
- The group decides the connector type. Pick a UiPath group. If
Group Titleis empty or isn't a number, the action fails withInvalid GroupId. If no group has that ID, it fails withConnector group (id: ...) not found. - Nothing is required by the connector. Empty fields are saved as empty, and signing in will fail later.
- The login isn't tested. A wrong password is saved without an error. Run Test Connector to check it. The test signs in to
https://platform.uipath.com. - Names aren't unique. Running the action twice with the same title creates two connectors.
- Keep secrets out of the action. The editor shows
Passwordas plain text. Pass the password through a token, for example from a form, instead of typing it into the action.
Examples
To understand how to use the below examples, please see Running Examples.
1. Save a customer's UiPath account
This action adds a connector to the UiPath group with ID [UiPathGroupId], using values from a form. The new connector's ID is saved in [UiPathConnectorId].
{
"Title": "Add UiPath Connector",
"ActionType": "cs.uipath",
"Description": "Save the customer's UiPath login",
"Parameters": {
"Group": "[UiPathGroupId]",
"EntryName": "UiPath - [CompanyName]",
"TenancyName": "[UiPathTenant]",
"Username": "[UiPathUsername]",
"Password": "[UiPathPassword]",
"EntryIdTokenName": "UiPathConnectorId"
}
}
Revised 09/26/2026