Struct User 

pub struct User { /* private fields */ }

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.

Implementations

impl User

pub fn get_id(&self) -> Option<&String>

Unique identifier of the user.

pub fn set_id(&mut self, id_arg: String)

Unique identifier of the user.

Example

S-1-5-21-202424912787-2692429404-2351956786-1000

pub fn get_name(&self) -> Option<&String>

Short name or login of the user.

pub fn set_name(&mut self, name_arg: String)

Short name or login of the user.

Example

a.einstein

pub fn get_full_name(&self) -> Option<&String>

User’s full name, if available.

pub fn set_full_name(&mut self, full_name_arg: String)

User’s full name, if available.

Example

Albert Einstein

pub fn get_email(&self) -> Option<&String>

User email address.

pub fn set_email(&mut self, email_arg: String)

User email address.

pub fn get_hash(&self) -> Option<&String>

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.

pub fn set_hash(&mut self, hash_arg: String)

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.

pub fn get_domain(&self) -> Option<&String>

Name of the directory the user is a member of.

For example, an LDAP or Active Directory domain name.

pub fn set_domain(&mut self, domain_arg: String)

Name of the directory the user is a member of.

For example, an LDAP or Active Directory domain name.

pub fn get_roles(&self) -> &Vec<String>

Array of user roles at the time of the event.

pub fn add_role(&mut self, role_arg: String)

Array of user roles at the time of the event.

Example

["kibana_admin", "reporting_user"]

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for User

fn default() -> User

Returns the “default value” for a type.

impl Serialize for User

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.