Skip to content

Commit

Permalink
Update markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
@heyams
heyams committed Aug 6, 2024
1 parent a47e5cd commit 53a121c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 21 deletions.
22 changes: 11 additions & 11 deletions docs/attributes-registry/user.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@

Describes information about the user.

| Attribute | Type | Description | Examples | Stability |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | ---------------------------------------------------------------- |
| `user.anonymous_id` | string | Identifier for a user who interacts with a system. This identifier may be unique only through best-effort means and does not imply that the user is authenticated to the system. [1] | `QdH5CAWJgqVT4rOr0qtumf` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.email` | string | User email address. | `a.einstein@example.com` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.full_name` | string | User's full name | `Albert Einstein` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.hash` | string | Unique user hash to correlate information for a user in anonymized form. [2] | `364fc68eaf4c8acec74a4e52d7d1feaa` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.id` | string | Unique identifier of the user. In the authentication context, this field should be treated as an authenticated user id, as opposed to the `anonymous_id` field. | `S-1-5-21-202424912787-2692429404-2351956786-1000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.name` | string | Short name or login/username of the user. | `a.einstein` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.roles` | string[] | Array of user roles at the time of the event. | `["admin", "reporting_user"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| Attribute | Type | Description | Examples | Stability |
| ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------- |
| `user.authentication.id` | string | Unique identifier of an authenticated user in the system. | `S-1-5-21-202424912787-2692429404-2351956786-1000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.email` | string | User email address. | `a.einstein@example.com` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.full_name` | string | User's full name | `Albert Einstein` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.hash` | string | Unique user hash to correlate information for a user in anonymized form. [1] | `364fc68eaf4c8acec74a4e52d7d1feaa` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.id` | string | Identifier of a user who interacts with a system. This identifier may be unique only through best-effort means and does not imply that the user is authenticated to the system. [2] | `QdH5CAWJgqVT4rOr0qtumf` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.name` | string | Short name or login/username of the user. | `a.einstein` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `user.roles` | string[] | Array of user roles at the time of the event. | `["admin", "reporting_user"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
**[1]:** Useful if `user.id` or `user.name` contain confidential information and cannot be used.

**[2]:** Useful if `user.id` or `user.name` contain confidential information and cannot be used.
**[2]:** It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
15 changes: 5 additions & 10 deletions model/registry/user.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,11 @@ groups:
note: >
It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
examples: ['QdH5CAWJgqVT4rOr0qtumf']
- id: authentication
prefix: user.authentication
type: attribute_group
brief: "Describes information about the user authentication."
attributes:
- id: id
type: string
brief: "Unique identifier of an authenticated user in the system."
examples: ['S-1-5-21-202424912787-2692429404-2351956786-1000']
stability: experimental
- id: authentication.id
type: string
brief: "Unique identifier of an authenticated user in the system."
examples: ['S-1-5-21-202424912787-2692429404-2351956786-1000']
stability: experimental
- id: name
type: string
stability: experimental
Expand Down

0 comments on commit 53a121c

Please sign in to comment.