Find Group
Audience:
Low-code Engineers,System/Security AdministratorsSkill Prerequisites:
Actions,Tokens,Connectors
Finds a connector group by its type and title, and saves the group's ID in a token. If there's no such group, the token is empty.
Every connector belongs to a group, and every group holds connectors of a single type. Use the ID to add connectors to the group, or to check whether the group exists before you create it with Add Group.
This action requires the Advanced Security feature (Enterprise) to be licensed.
Typical Use Cases
- Get the ID of an existing group before adding a connector to it with Add Imap Connector or Add POP3 Connector
- Check whether a group exists, and create it with Add Group only if it doesn't
Don't use it to
- Find a connector. Use Get Connector or Get User Connector instead.
Related Actions
| Action Name | Description |
|---|---|
| Add Group | Creates a new connector group. |
| Add Imap Connector | Adds an IMAP connector to a group. |
| Add POP3 Connector | Adds a POP3 connector to a group. |
| Get Connector | Reads a connector's data. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Connector Type | The type of connectors the group holds. Pick it from the list. In expression mode, the value must be the type name, for example ss.trigger.imap for IMAP or ss.trigger.pop3 for POP3. | Yes | empty string | Yes |
| Group title | The name of the group to find, for example Support Mailboxes. Case doesn't matter. | Yes | empty string | Yes |
| Output Token Name | The name of the token that gets the group's ID, for example ImapGroupId. | No | empty string | No |
Output Parameters Reference
| Parameter | Description |
|---|---|
| Output Token Name | The ID of the group, a number. It's empty if no group of that type has that title. |
Considerations
- Not found isn't an error. If the group doesn't exist, the action doesn't fail. The output token is just empty, so check it with a condition, for example
[ImapGroupId] == "". - An unknown type fails. If the connector type can't be found, the action fails with
Could not find the connector type with the provided name. - The title must match exactly, apart from case. Partial matches aren't found.
Examples
To understand how to use the below examples, please see Running Examples.
1. Find a group, and create it if it's missing
The first action looks for the IMAP group named Support Mailboxes and saves its ID in [ImapGroupId]. The second action only runs if the group wasn't found. It creates the group and saves the new ID in the same token.
[
{
"Title": "Find Group",
"ActionType": "CredStore.FindGroup",
"Description": "Look for the support IMAP group",
"Parameters": {
"Type": "ss.trigger.imap",
"GroupName": "Support Mailboxes",
"OutputToken": "ImapGroupId"
}
},
{
"Title": "Add Group",
"ActionType": "CredStore.AddGroup",
"Description": "Create the group if it doesn't exist",
"Condition": "[ImapGroupId] == \"\"",
"Parameters": {
"Type": "ss.trigger.imap",
"GroupName": "Support Mailboxes",
"GroupIdTokenName": "ImapGroupId"
}
}
]
Revised 09/26/2026