IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« URL Fields User Fields Usage and Examples »

› ›

User Fields

edit

User Fields

edit

The user fields describe information about the user that is relevant to the event.

Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.

User Field Details

edit

Field	Description	Level
user.domain	Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. type: keyword	extended
user.email	User email address. type: keyword	extended
user.full_name	User’s full name, if available. type: keyword Multi-fields: * user.full_name.text (type: text) example: `Albert Einstein`	extended
user.hash	Unique user hash to correlate information for a user in anonymized form. Useful if `user.id` or `user.name` contain confidential information and cannot be used. type: keyword	extended
user.id	Unique identifier of the user. type: keyword	core
user.name	Short name or login of the user. type: keyword Multi-fields: * user.name.text (type: text) example: `albert`	core
user.roles	Array of user roles at the time of the event. type: keyword Note: this field should contain an array of values. example: `["kibana_admin", "reporting_user"]`	extended

Field Reuse

edit

The user fields are expected to be nested at: client.user, destination.user, host.user, server.user, source.user, user.changes, user.effective, user.target.

Note also that the user fields may be used directly at the root of the events.

Field sets that can be nested under User

edit

Field Set	Location	Description
user	`user.changes.*`	Captures changes made to a user.
user	`user.effective.*`	User whose privileges were assumed.
group	`user.group.*`	User’s group relevant to the event.
user	`user.target.*`	Targeted user of action taken.

User Field Usage

edit

For usage and examples of the user fields, please see the User Fields Usage and Examples section.

« URL Fields User Fields Usage and Examples »