23 lines
1.7 KiB
Markdown
23 lines
1.7 KiB
Markdown
<!--- Hugo front matter used to generate the website version of this page:
|
|
--->
|
|
|
|
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
|
|
|
|
# User
|
|
|
|
## User Attributes
|
|
|
|
Describes information about the user.
|
|
|
|
| Attribute | Type | Description | Examples | Stability |
|
|
|---|---|---|---|---|
|
|
| <a id="user-email" href="#user-email">`user.email`</a> | string | User email address. | `a.einstein@example.com` |  |
|
|
| <a id="user-full-name" href="#user-full-name">`user.full_name`</a> | string | User's full name | `Albert Einstein` |  |
|
|
| <a id="user-hash" href="#user-hash">`user.hash`</a> | string | Unique user hash to correlate information for a user in anonymized form. [1] | `364fc68eaf4c8acec74a4e52d7d1feaa` |  |
|
|
| <a id="user-id" href="#user-id">`user.id`</a> | string | Unique identifier of the user. | `S-1-5-21-202424912787-2692429404-2351956786-1000` |  |
|
|
| <a id="user-name" href="#user-name">`user.name`</a> | string | Short name or login/username of the user. | `a.einstein` |  |
|
|
| <a id="user-roles" href="#user-roles">`user.roles`</a> | string[] | Array of user roles at the time of the event. | `["admin", "reporting_user"]` |  |
|
|
|
|
**[1] `user.hash`:** Useful if `user.id` or `user.name` contain confidential information and cannot be used.
|