Get Connector
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Tokens,Connectors
Reads a connector and puts its details into tokens: its ID, name, group and property values. You either pick the connector in the editor or pass its ID. Secure values, such as passwords and API keys, come back masked as ******.
This action requires the Advanced Security feature (Enterprise) to be licensed. If it isn't, the action fails with a message that the feature is unlicensed.
Typical Use Cases
- Show a connector's name, group and non-secret settings, for example a server name or login URL, on a page or in an email
- Check that a connector ID from a token points to an existing connector before you use it
- Read a connector's custom data values to drive later actions
Don't use it to
- Read passwords, API keys or other secure values. They're always returned as
******. - Find the connector that belongs to a user. Use Get User Connector instead.
- Check that a connector works. Use Test Connector instead.
Related Actions
| Action Name | Description |
|---|---|
| Get User Connector | Gets the ID of a user's connector in a group. |
| Add Connector | Creates a new connector and returns its ID. |
| Update Connector | Changes the properties of a connector. |
| Find Group | Gets a connector group ID from its title. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Selection Mode | How the connector is chosen. Select By Name lets you pick it from lists in the editor. Select By Id uses the value of Entry Id. | No | Select By Name | Yes |
| Entry Id | The ID of the connector, a GUID, for example [ConnectorId]. Shown when Selection Mode is Select By Id. | Yes | empty string | Yes, for Select By Id |
| Connector Type | Narrows the Connector Group list to one connector type. Shown when Selection Mode is Select By Name. | No | empty string | No |
| Connector Group | Narrows the Connector Entry list to one group. Shown when Selection Mode is Select By Name. | No | empty string | No |
| Connector Entry | The connector to read. Shown when Selection Mode is Select By Name. | No | empty string | Yes, for Select By Name |
Output Parameters Reference
The token names are fixed. Running the action again replaces them.
| Token | Description |
|---|---|
[CredentialEntryInfo:EntryId] | The ID of the connector. |
[CredentialEntryInfo:EntryName] | The name of the connector. |
[CredentialEntryInfo:GroupId] | The ID of the connector's group. |
[CredentialEntryInfo:GroupName] | The name of the connector's group. Connectors created on the Connectors page are in the Connector group. |
[CredentialEntryData:<Key>] | One token for each stored value, where <Key> is the property ID of the type, for example [CredentialEntryData:ConnectionString], or a custom data key. Secure values are ******. |
Considerations
- A missing connector isn't an error. If the connector doesn't exist, or
Entry Idis empty, the action does nothing and no tokens are set. Check[CredentialEntryInfo:EntryId]before you use the other tokens. Select By Nameis a fixed choice. It saves the connector you pick in the editor. The type and group lists only help you find it. To choose a connector at run time, useSelect By Id.
Examples
To understand how to use the below examples, please see Running Examples.
1. Read a connector by ID
This action reads the connector whose ID is in [ConnectorId]. Afterward, [CredentialEntryInfo:EntryName] holds its name and [CredentialEntryInfo:GroupName] its group.
{
"Title": "Get Connector",
"ActionType": "CredStore.GetEntry",
"Description": "Load the selected connector's details",
"Condition": "[ConnectorId] != \"\"",
"Parameters": {
"SelectionMode": "byid",
"EntryId": "[ConnectorId]"
}
}
Revised 09/26/2026