# Recipient Groups

Every LUCY campaign needs at least one recipient group—users who will receive the simulation or training content. You can create multiple groups per campaign to target users by department, location, domain, or other criteria. Users can belong to multiple groups, and there’s no limit to how many you can create.

## Creating a New Group

{% hint style="info" %}
Navigate to **Users > Recipient Groups**
{% endhint %}

You can add recipients manually or import them via CSV, LDAP, or Azure (Entra ID).

{% hint style="success" %}
Importing recipients from company directories is recommended as it allows you to include additional information about each user, which enhances automatic analysis and statistics.
{% endhint %}

1. Select "**New Group**" and fill out the group information.

<figure><img src="/files/8zFO4D8nlrLzQWfVhGa1" alt="" width="563"><figcaption></figcaption></figure>

<figure><img src="/files/qXfHryFegQjTKL3m0FJj" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Name" %}
This is a required field where you'll enter the name of the new group you are creating. It's important to emphasize clear identification for efficient management within the system.
{% endtab %}

{% tab title="Client" %}
This dropdown menu allows you to select which [client](/application-reference/settings/clients.md) the group is associated with.
{% endtab %}

{% tab title="Default Language" %}
This setting determines the language used for group content delivery when the recipient records do not specify a language.
{% endtab %}

{% tab title="Portable Media Attack" %}
{% hint style="danger" %}
This feature is deprecated, do not enable it.
{% endhint %}
{% endtab %}
{% endtabs %}

***

## Adding Recipients

There are four methods to import recipients into Lucy.

{% tabs %}
{% tab title="Manual" %}
Directly input recipient details one by one. This method is feasible for small numbers of recipients but becomes time-consuming for larger sets.

<figure><img src="/files/W172CpgQSrfu757LHW2A" alt=""><figcaption></figcaption></figure>

Select "**New Recipient**"

Provide all necessary details of the recipient. The more fields that are filled, the more granular the statistics can be.

{% hint style="success" %}
Each recipient must have a first name and at least one contact method—either an email address, a phone number, or both.
{% endhint %}

<figure><img src="/files/e0B6StxELGAKd2YjgEQo" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="CSV" %}

<figure><img src="/files/i6VESmHuuWgm1FHCyEaT" alt=""><figcaption></figcaption></figure>

Here is an example CSV for reference:

{% file src="/files/ZH50ddhE8KwHN2FQe2eC" %}

The import file should contain text in UTF-8 encoding. Each line should represent one recipient. Each record can have 1 to 12 columns, separated by a comma, colon, or semicolon (, : or ;). The possible columns are:

1. Email - recipient's email address (**mandatory**)
2. Full Name - recipient's full name
3. Staff - job position or related information
4. Location - recipient's location
5. Division - company division
6. Comment - any custom comment
7. Link - unique link part for the landing page (ensure uniqueness if specified; otherwise, it will be generated automatically)
8. Phone - recipient's phone number
9. Language - recipient's language
10. Gender - recipient's gender ("m" for Male; "f" for Female)
11. First Name - recipient's first name (**mandatory**)
12. Last Name - recipient's last name

{% hint style="success" %}
To leave a column blank, leave it empty between the separators like so:

<user@example.com>;Jane Doe;;USA;HR;;;;English;F;Jane;Doe;

This recipient does not have values for Staff, Comment, Link, or Phone.
{% endhint %}

#### Import CSV

Select "**Choose File**" to import your recipients, then select **"Import"**.

<figure><img src="/files/dGb6LYgyYFEzMUPvWMeM" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="LDAP Server" %}
For instructions on connecting an LDAP server refer to the [LDAP Integration article](/application-reference/settings/common-system-settings/ldap-servers.md).

***

### Import Options

<figure><img src="/files/bJp268dhtGh1XXYDGd7l" alt=""><figcaption></figcaption></figure>

**Update existing recipients**

* If this option is enabled, any existing recipients in this group will have their attributes updated during the LDAP import. This ensures that the latest information from the LDAP server is reflected in the recipient list.

**Add recipients to bound campaigns**

* Enabling this option will add the imported recipients to any campaigns that are already bound to the group. This is useful if you want to expand the reach of your current campaigns to include new or updated recipients.

**Send emails if bound campaigns are running**

* If this option is selected, emails will be sent to the newly imported recipients if they are part of running campaigns. This ensures that any active campaigns will immediately include the new recipients in their email distribution.

**Add more groups**

* This option allows you to import additional groups already present in Lucy. This can be helpful if you want to organize recipients into specific categories or segment groups for targeted campaigns.

***

### LDAP Server

Select the [LDAP Server](/application-reference/settings/common-system-settings/ldap-servers.md) which needs to be associated with this group.

***

### LDAP Search

You can use standard Active Directory search filters, such as:

```
(|(objectClass=inetOrgPerson)(objectClass=user))
```

For more information, refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/windows/win32/adsi/search-filter-syntax).

***

### Import

After successfully retrieving the desired recipients from your company directory, select the checkbox to include All, and click "Import" to begin the import process.

<figure><img src="/files/yn5J3bLkn8gOuKMAmHgQ" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Azure (Entra ID)" %}
For instructions on connecting an Azure application refer to the [Azure Applications](/application-reference/settings/common-system-settings/azure-applications.md) article.

***

### Import Options

<figure><img src="/files/Lr0JNmrRWbk1BHHl7NKd" alt=""><figcaption></figcaption></figure>

**Update existing recipients**

* If this option is enabled, any existing recipients in this group will have their attributes updated during the Entra ID import. This ensures that the latest information from the Entra ID server is reflected in the recipient list.

**Add recipients to bound campaigns**

* Enabling this option will add the imported recipients to any campaigns that are already bound to the group. This is useful if you want to expand the reach of your current campaigns to include new or updated recipients.

**Send emails if bound campaigns are running**

* If this option is selected, emails will be sent to the newly imported recipients if they are part of running campaigns. This ensures that any active campaigns will immediately include the new recipients in their email distribution.

**Add more groups**

* This option allows you to import additional groups already present in Lucy. This can be helpful if you want to organize recipients into specific categories or segment groups for targeted campaigns.

***

### Azure Application

Select the [Azure Application](/application-reference/settings/common-system-settings/azure-applications.md) which needs to be associated with this group.

***

### Azure Search

**Filter by Groups**

Select a group from the dropdown list:

<figure><img src="/files/9ewS9oDUEYwDDPAOfW9M" alt=""><figcaption></figcaption></figure>

**Filter by Search Parameters**

Use [Microsoft search filters](https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#filter-parameter).

Here are some common examples:

1. All users with a certain email domain

```
endsWith(mail, '@example.com')
```

2. All users with a certain username

```
startsWith(mail, 'username')
```

3. All users in the same location

```
officeLocation eq 'Regional Headquarters'
```

### Import

After successfully retrieving the desired recipients from your company directory, select the checkbox to include All, and click "Import" to begin the import process.

<figure><img src="/files/VbiYeOSqAfbn6PfvNLoR" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

***

## Autoupdate Recipients

You can automatically sync your recipients from LDAP or Azure AD by defining the import parameters on the **Import Settings** tab. This sync runs in the background every 10 minutes.

<figure><img src="/files/5QEOKUL8oEopKe9QwRcQ" alt=""><figcaption></figcaption></figure>

***

### Import Type

Automatically sync from your LDAP or Azure AD application.

<figure><img src="/files/zD7CQxsb9zPjY7SNXtOI" alt="" width="563"><figcaption></figcaption></figure>

{% tabs %}
{% tab title="LDAP" %}
You can employ standard Active Directory search filters, such as:

```
(|(objectClass=inetOrgPerson)(objectClass=user))
```

This filter retrieves objects that are either of type `inetOrgPerson` or `user`.

For further details and guidance, refer to the [Microsoft Documentation](https://learn.microsoft.com/en-us/archive/technet-wiki/5392.active-directory-ldap-syntax-filters).
{% endtab %}

{% tab title="Azure Entra ID" %}
**Filter by Groups**

Select a group from the dropdown list:

<figure><img src="/files/62DeDvvprjEJjAeLLDi6" alt=""><figcaption></figcaption></figure>

**Filter by Search Parameters**

Use [Microsoft search filters](https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#filter-parameter).

Here are some common examples:

1. All users with a certain email domain

```
endsWith(mail, '@example.com')
```

2. All users with a certain username

```
startsWith(mail, 'username')
```

3. All users in the same location

```
officeLocation eq 'Regional Headquarters'
```

{% endtab %}
{% endtabs %}

***

### Action for New Recipients

{% tabs %}
{% tab title="Waiting for Administrator" %}
If this option is selected, the automatic import will list all recipients in the Control List for both LDAP and Azure Entra ID integrations.

<figure><img src="/files/Cg8zufERzwJXYuS0QABu" alt=""><figcaption></figcaption></figure>

Your Lucy server will make a query every 10 minutes to your company directory to obtain the most updated list of your recipient directory.

You can manually **add** each recipient:

<figure><img src="/files/xyESUg0jcHlDesrfdnm9" alt=""><figcaption></figcaption></figure>

Or you can select All recipients and **Apply** them to your Group:

<figure><img src="/files/qsf2cHEjkZBUxKRnbmBx" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Automatically Add" %}

#### Automatically Add to Bounded Campaigns

When this option is selected, the recipients will be imported automatically and added to all campaigns the recipient group is bound to.

***

#### Automatically Add to Bounded Campaigns and Schedule Plans

When this option is selected, the recipients will be imported automatically and added to all campaigns the recipient group is bound to, in addition any Schedule Plans with this recipient group will also be updated to reflect the new recipients.
{% endtab %}
{% endtabs %}

***

### Action for Deleted Recipients

{% tabs %}
{% tab title="Waiting for Administrator" %}
If this option is selected, the automatic deletion will list all recipients in the Control List for both LDAP and Azure Entra ID integrations.

<figure><img src="/files/DuCzwC9zO5evw8hlpjC4" alt=""><figcaption></figcaption></figure>

Your Lucy server will make a query every 10 minutes to your company directory to obtain the most updated list of your recipient directory.

You can manually **Discard** each recipient:

<figure><img src="/files/MYZlund8rNaZRqdLCKHF" alt=""><figcaption></figcaption></figure>

Or you can select All recipients and **Discard** them to your Group:

<figure><img src="/files/ufc2fc2DwZuDNguRlY8v" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Automatically Delete Inactive" %}
When this option is selected, the recipients not "Active" or deleted in the company directory will be automatically removed from the group and all subsequent campaigns.&#x20;
{% endtab %}

{% tab title="Never Delete" %}
When this option is selected, no recipients will be deleted even if Lucy has determined the recipient is not "Active" in your company directory.
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.lucysecurity.com/application-reference/users/recipient-groups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.