Target Users

The Target Users are those who receive e-mails that will be sent through the platform. This document explains how to add target users to the platform so that it can send training, phishing, campaigns, and other emails to them.

Managing Target Users

You can manage all target users from the Company > Target Users menu. You may create, remove, modify, and add target users to a group on this page.

The platform will notify the system user to validate the email domains after creating the target users on the platform. For more information, click here.

Methods for Adding Target Users

1. Adding Target Users via XLS(x) or CSV Files

You can easily add target users to the system by importing a list on an Excel file. To use this option, please follow the steps below:

  • Go to the Company > Target Users menu.

  • Click the "New" button.

  • Click the "Import from a file" option.

  • To view a sample sheet, please click "DOWNLOAD EXAMPLE SHEET" on the target users page.

After downloading a sample sheet, it's time to fill in the required fields. Please open the sheet file and fill in the following fields.

  • First Name: It's required.

  • Last Name: It's required.

  • Email Address: It's required.

  • Phone Number: It's optional.

  • Department: It's optional.

  • Time Zone: It's optional. Please see the following information if you prefer to use the time zone for your target users in your sheet file.

  • Priority: It's optional.

The downloaded spreadsheet has time zones in SHEET2. Please copy all time zones from the "Time Zone" column in SHEET2 and paste them properly for your target user's time zone column.

After your file is ready, please follow the steps below:

  • Go to the Company > Target Users menu.

  • Click the "New" button.

  • Click the "Import from a file" option.

  • Click Upload File, choose the file on your computer, and click NEXT.

  • The Map Fields tab will require you to match the titles to the fields on the platform.

  • When you complete matching the fields, click NEXT.

  • Then either pick the users you wish to add and click IMPORT SELECTED, or click IMPORT ALL to add all the users to the platform.

2. Adding Target Users Manually

​​From the left menu, select Company > Target Users. Then, click New and click "Add users manually" on the new page. Fill out the required boxes in the "Add New User" window to add a new target user to the system.

3. Adding Target Users via SCIM

SCIM (System for Cross-domain Identity Management) is a standard that automates the sharing of user identity information (e.g., first name, last name, email, phone number) across multiple identity platforms. Keepnet's platform supports SCIM integration to automate and synchronize target user data from identity providers to the platform.

Please click here to learn how to set up or synchronize your employees' information via SCIM on the platform.

4. Adding Target Users via LDAP

LDAP is a standard protocol that allows platforms to access an Active Directory to retrieve user information, such as name, surname, email, department, phone number, and other details, enabling automatic synchronization with the platform. The benefits of LDAP include automating user management, saving time, reducing stress, and minimizing manual user management tasks.

Please click here to learn how to set up and synchronize your employees' information via LDAP integration.

5. Adding Target Users via API

Using the platform's APIs, target users may be effortlessly migrated. The API endpoints that are required are detailed below.

You need to create Rest API keys on the platform from here in order to use this API import option.

Use your own domain if you are using an on-premise version. e.g. https://api.PLATFORM_DOMAIN/docs/index.html

Instructions for adding target users using an API

POST ​/api​/target-users

  • Go to the Swagger link.

  • Click the Authorize button on the top right side of the page.

  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

  • Make sure that the api1 option is checked (✓) on the Scopes section.

  • Then use this endpoint to add a new target user to the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Searching for a user using API

POST ​/api​/target-users​/search

  • Go to the Swagger link.

  • Click the Authorize button on the top right side of the page.

  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

  • Make sure that the api1 option is checked (✓) on the Scopes section.

  • Then use this endpoint to search for a target user on the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Editing Target Users using API

PUT ​/api​/target-users​/{resourceId}

  • Go to the Swagger link.

  • Click the Authorize button on the top right side of the page.

  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

  • Make sure that the api1 option is checked (✓) on the Scopes section.

  • Then use this endpoint to edit a target user on the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Deleting Target Users using API

DELETE ​/api​/target-users​/{resourceId}

  • Go to the Swagger link.

  • Click the Authorize button on the top right side of the page.

  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

  • Make sure that the api1 option is checked (✓) on the Scopes section.

  • Then use this endpoint to delete a target user on the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Adding Target Users to Groups

You may create new groups by clicking the New button on the Company > Target Users > Group menu.

To add target users to a group, clickicon under the Action column and click Add users to the group. Select the users you want to add to a group and click “Add Selected Users” to complete the process.

Deleting Target Users

To delete target users on the platform, go to the Company > Target Users > People menu and select the user(s) that you want to remove. Clickicon under the Action column and click “Delete” to complete the process.

Deleting Groups

To delete target user groups on the platform, go to the Company > Target Users > Group menu and select the group(s) that you want to remove. Clickicon under the Action column and click “Delete” to complete the process.

Deleting a target user group will not delete the users defined in the group. It will only delete the group.

Video Tutorial

The Target Users are those who receive e-mails that will be sent through the platform. This video tutorial explains how to add target users to the platform so that it can send training, phishing, campaigns, and other emails to them.

FAQ

Q: Is it possible to add a target user with any domain name?

A: You can only add e-mail addresses with authorized domains. Contact your Account Manager or Support Team if you wish to add users with a different domain address.

Q: Would the remaining license count increase when a target user is deleted?

A: No, when a target user is added, your remaining license is reduced appropriately, but your license is not increased when the target user is deleted.

Q: What will happen when the license count is exceeded?

A: The system will warn the admin when add a new user although the license count is exceeded. If the admin goes further and adds new users, each unique user will be charged. Please contact the support team for the additional license.

Q: What will happen when the license date is expired?

A: All data will stay remain but the admin will not be able to login into the platform. Please contact the support team to renew the license.

Q: Can I add a custom column under the "People" page in Target Users?

A: Yes, go to Company > Target Users > People and click the Settings button to open table settings. After that, click the EDIT FIELDS button to create or manage any custom fields.

Last updated

Copyright © Keepnet Labs LTD. All rights reserved.