Skip to content

Commit 2ccbfe3

Browse files
committed
Update
1 parent 2b09f28 commit 2ccbfe3

File tree

6 files changed

+10
-34
lines changed

6 files changed

+10
-34
lines changed

.chloggen/add_enduser_authentication_id.yaml .chloggen/add_enduser_pseudo_id.yaml

+2-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ change_type: enhancement
1010
component: enduser
1111

1212
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13-
note: introduce new attribute `enduser.authentication.id`, replace `enduser.id` with `enduser.pseudo.id`, and deprecate `enduser.authentication.role`, and `enduser.authentication.scope`.
13+
note: introduce new attribute `enduser.pseudo.id`
1414

1515
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
1616
# The values here must be integers.
@@ -20,5 +20,4 @@ issues: [1104]
2020
# These lines will be padded with 2 spaces and then inserted directly into the document.
2121
# Use pipe (|) for multiline entries.
2222
subtext: |
23-
The new attribute `enduser.authentication.id` is intended to provide an unique identifier of an authenticated enduser.
24-
The deprecated attributes `enduser.authentication.role` and `enduser.authentication.scope` are removed from the enduser registry.
23+
The new attribute `enduser.pseudo.id` is intended to provide an unique identifier of an authenticated enduser.

docs/attributes-registry/enduser.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Describes information about the end user, which can be used as a subdomain of br
1515

1616
| Attribute | Type | Description | Examples | Stability |
1717
|---|---|---|---|---|
18-
| <a id="enduser-authentication-id" href="#enduser-authentication-id">`enduser.authentication.id`</a> | 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) |
18+
| <a id="enduser-id" href="#enduser-id">`enduser.id`</a> | string | Unique identifier of an authenticated user in the system. | `<authenticated_user_id>` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1919
| <a id="enduser-pseudo-id" href="#enduser-pseudo-id">`enduser.pseudo.id`</a> | string | Pseudonymous identifier of an end user. This identifier is unique to the user but does not reveal their actual identity. | `QdH5CAWJgqVT4rOr0qtumf` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2020

2121
## Deprecated End User Attributes
@@ -24,6 +24,5 @@ Describes deprecated end user attributes.
2424

2525
| Attribute | Type | Description | Examples | Stability |
2626
|---|---|---|---|---|
27-
| <a id="enduser-id" href="#enduser-id">`enduser.id`</a> | string | Deprecated, use `enduser.pseudo.id` instead. | `QdH5CAWJgqVT4rOr0qtumf` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `enduser.pseudo.id`. |
2827
| <a id="enduser-role" href="#enduser-role">`enduser.role`</a> | string | Actual/assumed role the client is making the request under extracted from token or application security context. | `admin` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed. |
2928
| <a id="enduser-scope" href="#enduser-scope">`enduser.scope`</a> | string | Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute value in a [SAML 2.0 Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). | `read:message, write:files` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed. |

docs/general/attributes.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -396,13 +396,8 @@ These attributes may be used for any operation with an authenticated and/or auth
396396

397397
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
398398
|---|---|---|---|---|---|
399-
| [`enduser.authentication.id`](/docs/attributes-registry/enduser.md) | string | Unique identifier of an authenticated user in the system. [1] | `S-1-5-21-202424912787-2692429404-2351956786-1000` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
400-
| [`enduser.id`](/docs/attributes-registry/enduser.md) | string | Deprecated, use `enduser.pseudo.id` instead. | `QdH5CAWJgqVT4rOr0qtumf` | `Recommended` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `enduser.pseudo.id` attribute. |
399+
| [`enduser.id`](/docs/attributes-registry/enduser.md) | string | Unique identifier of an authenticated user in the system. | `<authenticated_user_id>` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
401400
| [`enduser.pseudo.id`](/docs/attributes-registry/enduser.md) | string | Pseudonymous identifier of an end user. This identifier is unique to the user but does not reveal their actual identity. | `QdH5CAWJgqVT4rOr0qtumf` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
402-
| [`enduser.role`](/docs/attributes-registry/enduser.md) | string | Actual/assumed role the client is making the request under extracted from token or application security context. | `admin` | `Recommended` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed. |
403-
| [`enduser.scope`](/docs/attributes-registry/enduser.md) | string | Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute value in a [SAML 2.0 Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). | `read:message, write:files` | `Recommended` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed. |
404-
405-
**[1] `enduser.authentication.id`:** The `enduser.authentication.id` attribute is intended to provide an unique identifier of an authenticated enduser. The deprecated attributes `enduser.authentication.role` and `enduser.authentication.scope` are removed from the enduser registry.
406401

407402
<!-- markdownlint-restore -->
408403
<!-- prettier-ignore-end -->

model/enduser/common.yaml

-12
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,6 @@ groups:
55
These attributes may be used for any operation with an authenticated and/or authorized enduser.
66
attributes:
77
- ref: enduser.id
8-
deprecated: Replaced by `enduser.pseudo.id` attribute.
98
requirement_level: recommended
109
- ref: enduser.pseudo.id
1110
requirement_level: recommended
12-
- ref: enduser.role
13-
deprecated: "Removed."
14-
requirement_level: recommended
15-
- ref: enduser.scope
16-
deprecated: "Removed."
17-
requirement_level: recommended
18-
- ref: enduser.authentication.id
19-
requirement_level: required
20-
note: >
21-
The `enduser.authentication.id` attribute is intended to provide an unique identifier of an authenticated enduser.
22-
The deprecated attributes `enduser.authentication.role` and `enduser.authentication.scope` are removed from the enduser registry.

model/enduser/deprecated/registry-deprecated.yaml

-6
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ groups:
44
display_name: Deprecated End User Attributes
55
brief: "Describes deprecated end user attributes."
66
attributes:
7-
- id: enduser.id
8-
type: string
9-
brief: 'Deprecated, use `enduser.pseudo.id` instead.'
10-
stability: experimental
11-
deprecated: "Replaced by `enduser.pseudo.id`."
12-
examples: ['QdH5CAWJgqVT4rOr0qtumf']
137
- id: enduser.role
148
type: string
159
deprecated: "Removed."

model/enduser/registry.yaml

+6-5
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ groups:
55
brief: >
66
Describes information about the end user, which can be used as a subdomain of browser, client, or user domains.
77
attributes:
8+
- id: enduser.id
9+
type: string
10+
brief: "Unique identifier of an authenticated user in the system."
11+
examples: [ '<authenticated_user_id>' ]
12+
stability: experimental
813
- id: enduser.pseudo.id
914
type: string
1015
stability: experimental
1116
brief: >
1217
Pseudonymous identifier of an end user. This identifier is unique to the user but does not reveal their actual identity.
1318
examples: ['QdH5CAWJgqVT4rOr0qtumf']
14-
- id: enduser.authentication.id
15-
type: string
16-
brief: "Unique identifier of an authenticated user in the system."
17-
examples: [ 'S-1-5-21-202424912787-2692429404-2351956786-1000' ]
18-
stability: experimental
19+

0 commit comments

Comments
 (0)