Auto-Generated Documentation
This set of documentation is automatically generated from source, and will help ensure any change to functionality will always be documented and available on release.
User¶
The user fields describe information about the user that is relevant to the event.
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| domain | Keyword | Name of the directory the user is a member of. | Optional | None |
| User email address. | Optional | None |
||
| full_name | Keyword | User’s full name, if available. | Optional | None |
| group | Group | User’s group relevant to the event. | Optional | None |
| hash | Keyword | Unique user hash to correlate information for a user in anonymized form. | Optional | None |
| id | Keyword | Unique identifier of the user. | Optional | None |
| name | Keyword | Short name or login of the user. | Optional | None |
| roles | List [Keyword] | Array of user roles at the time of the event. | Optional | [] |