semantic-conventions/docs/registry/attributes/enduser.md

36 lines
1.9 KiB
Markdown

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# Enduser
- [End User Attributes](#end-user-attributes)
- [Deprecated End User Attributes](#deprecated-end-user-attributes)
## End User Attributes
Describes the end user.
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="enduser-id" href="#enduser-id">`enduser.id`</a> | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="enduser-pseudo-id" href="#enduser-pseudo-id">`enduser.pseudo.id`</a> | string | Pseudonymous identifier of an end user. This identifier should be a random value that is not directly linked or associated with the end user's actual identity. [2] | `QdH5CAWJgqVT4rOr0qtumf` | ![Development](https://img.shields.io/badge/-development-blue) |
**[1] `enduser.id`:** Unique identifier of an end user in the system.
> [!Warning]
> This field contains sensitive (PII) information.
**[2] `enduser.pseudo.id`:** Pseudonymous identifier of an end user.
> [!Warning]
> This field contains sensitive (linkable PII) information.
## Deprecated End User Attributes
Describes deprecated enduser attributes.
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="enduser-role" href="#enduser-role">`enduser.role`</a> | string | Deprecated, use `user.roles` instead. | `admin` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `user.roles`. |
| <a id="enduser-scope" href="#enduser-scope">`enduser.scope`</a> | string | Deprecated, no replacement at this time. | `read:message, write:files` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed, no replacement at this time. |