CSV Users Export
Description
Specifies what data to include in the export. A download button is included on the user list page. When pressed the current selection (filter) of users are downloaded as a CSV file.
For efficiency reasons, prefer using a "User Store Configuration" over a "User Persister Configuration".
May be used by
Properties
Type (
type) Description
Valid values of this property are:
- BASIC: The downloaded file contains only basic infos about the user (username, roles) plus the context data selected by the context keys.
- FULL: The downloaded file contains all available data about the user plus the context data.
Attributes
Enum
Optional
Default value
BASIC
Context Keys (
contextKeys) Description
This property specifies a list of keys of the context data values to be included in the user data download file. Only values are included that the admin user is allowed to see (according to authorization settings).
Attributes
String-List
Optional
Charset (
charset) Description
Defines the character set to use when exporting the user list as CSV file.
Attributes
String
Optional
Default value
UTF-8
Allowed values
UTF-8, ISO-8859-1, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, ISO-8859-15
Separation Character (
separationCharacter) Description
This property specifies the separation character used in the generated CSV file in order to separate fields from eachother. Usually, a comma is used but, e.g., Excel requires this to be a semicolon. To use the generated file with Excel, use a semicolon, to use it with most programs, use a comma. The separator character MAY be surrounded by double quotes. E.g., the space character is specified as " ".
Attributes
String
Optional
Default value
;
Suggested values
,, ;, :, |
YAML Template (with default values)
type: CsvUsersExport
id: CsvUsersExport-xxxxxx
displayName:
comment:
properties:
charset: UTF-8
contextKeys:
separationCharacter: ;
type: BASIC