Importing user entries from a CSV file

Administrator Help | Forcepoint DLP | Version 8.4.x

User directories information can be imported via CSV files. To do this, generate a set of files in a specific structure, as follows:

Create 3 text files named computers.csv, users.csv, and groups.csv. See CSV file formatting for details on the format.

Click New in the toolbar at the top of the Settings > General > User Directories page.

Select CSV File in the Type field.

Enter the path of the CSV files.

Enter a user name and a password with access to this directory.

Click OK.

Each time you want to import user, group, or computer data from the CSV files, go to the Settings > General > User Directories page and click Import Now in the toolbar at the top of the page.

CSV file formatting

When creating user directory files in CSV format, ensure that these conditions are met:

Encoding:

Use the UTF-8 character set or use a character set that is supported by its JVM installation.

Separate fields using commas.

End each record with a line feed or carriage return/line feed.

Escaping and quotes:

Enclose fields that contain a special character (semicolon, new line, or double quote) in double quotes.

If a field's value contains a double-quote character, escape it by placing another double-quote character next to it.

Omit optional fields and replace them with the delimiter.

When a field contains a list, separate the list elements using a semicolon (;) and enclose the entire field in double quotes, unless the list contains 1 element or none.

Groups file format

Each row in the groups.csv file should contain:


Name	Data Type	Optional	Description
UUID	String	No	The record's universal unique identifier
Group name	String	No	Name of user directory group
Description	String	Yes	Description
memberOf	List of UUID	Yes	UUIDs of which this group is a member (can be empty)

For example:

08b3b46b-3631-46cb-adc7-176c2871e94c,Marketing - EMEA, Marketing department,7c9d4db6-1737-4b80-9e6e-42f415300a05

40632a33-db39-4f93-bd80-093e0b3230ca,Marketing - APAC, Marketing department,7c9d4db6-1737-4b80-9e6e-42f415300a05

7c9d4db6-1737-4b80-9e6e-42f415300a05,Marketing all,All Marketing departments

Users file format

Each row in the users.csv file should contain:


Name	Data Type	Optional	Description
UUID	String	No	The record's universal unique identifier
Username	String	No	Login or user ID
Email	String	Yes	Email address (primary)
Description	String	Yes	Description
UUID	String	Yes	UUID of the current user's manager
memberOf	List of UUID	Yes	UUIDs of which this group is a member (can be empty)
Zero or more "additional attributes" fields	String	Yes	See "Additional Attributes" below

User records can also have additional attributes in the form of name value pairs. Some of these attributes have predefined names (see below). A file containing an additional attribute should be defined as a regular expression of the following format:

[aA][tT][tT][rR]:(.+)/=/(.+)

Any name can be used for custom attributes. The attributes are stored as an associated array on the user object, and are used only for display. Examples include:

wbsn_proxy_address - secondary (alternative) email address

wbsn_nt_domain\wbsn_login_name - the user login name (principal name on Windows-based systems)

wbsn_full_name - the user's display name

wbsn_department - department

wbsn_telephone_number - the user's telephone number

wbsn_title - the user's title

wbsn_mailbox_store - the server on which the user's Exchange mailbox is stored

The table below illustrates some attributes:


String	Name	Value
attr:wbsn_title/=/Manager	wbsn_title	Manager
aTTr:my amazing attr/=/the value	my amazing attr	the value
"ATTR:name/=/value1,value2"	name	value1,value2

For example:

6278ab76-2ce2-4f16-8e49-aa5104da7d0b, jdoe-mgr, jdoe.manager@example.com,CEO,7c9d4db6-1737-4b80-9e6e-42f415300a05,attr:room/=/201,attr:parkingSpace/=/1

ff255105-4e43-4e9a-b2bd-e366872cd212, jdoe, jdoe@example.com, administrator, 6278ab76-2ce2-4f16-8e49-aa5104da7d0b,"08b3b46b-3631-46cb-adc7-176c2871e94c;7c9d4db6-1737-4b80-9e6e-42f415300a05",attr:room/=/101

Computers file format

Each row in computers.csv should contain:


Name	Data Type	Optional	Description
UUID	String	No	The record's universal unique identifier
Name	String	No	Computer name (hostname)
FQDN	String	Yes	DNS fully qualified domain name
Description	String	Yes	Description
memberOf	List of UUID	Yes	UUIDs of which this group is a member (can be empty)

For example:

379a287f-0a5c-40ff-85fd-fae3da462d03,gumby, gumby.example.com, print server,"7c9d4db6-1737-4b80-9e6e-42f415300a05"