Skip to main content
Version: 1.28 (Current)

Get Connector

Audience: Low-code Engineers

Skill 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 ******.

note

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.
Action NameDescription
Get User ConnectorGets the ID of a user's connector in a group.
Add ConnectorCreates a new connector and returns its ID.
Update ConnectorChanges the properties of a connector.
Find GroupGets a connector group ID from its title.

Input Parameter Reference​

ParameterDescriptionSupports TokensDefaultRequired
Selection ModeHow 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.NoSelect By NameYes
Entry IdThe ID of the connector, a GUID, for example [ConnectorId]. Shown when Selection Mode is Select By Id.Yesempty stringYes, for Select By Id
Connector TypeNarrows the Connector Group list to one connector type. Shown when Selection Mode is Select By Name.Noempty stringNo
Connector GroupNarrows the Connector Entry list to one group. Shown when Selection Mode is Select By Name.Noempty stringNo
Connector EntryThe connector to read. Shown when Selection Mode is Select By Name.Noempty stringYes, for Select By Name

Output Parameters Reference​

The token names are fixed. Running the action again replaces them.

TokenDescription
[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 Id is empty, the action does nothing and no tokens are set. Check [CredentialEntryInfo:EntryId] before you use the other tokens.
  • Select By Name is 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, use Select By Id.

Examples​

tip

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