Skip to content

Commit 3e1655f

Browse files
committed
Add authentication to enduser namespace
1 parent 6e77ed5 commit 3e1655f

File tree

6 files changed

+83
-36
lines changed

6 files changed

+83
-36
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: new_component
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: enduser
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: introduce subnamespace `enduser.authentication` with new attributes `enduser.authentication.id`, `enduser.authentication.role`, and `enduser.authentication.scope`.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [1104]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext: |
23+
The `enduser.authentication` subnamespace is intended to describe the authentication information of the end user.
24+
The new attributes are intended to provide information about the authenticated user in the system,
25+
the role the client is making the request under, and the scopes or granted authorities the client currently possesses.

model/authentication/registry.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
groups:
2+
- id: registry.authentication
3+
type: attribute_group
4+
display_name: Authentication Attributes
5+
stability: experimental
6+
brief: >
7+
"Describes the authentication information of an authenticated user."
8+
attributes:
9+
- id: authentication.id
10+
type: string
11+
brief: "Unique identifier of an authenticated user in the system."
12+
examples: [ 'S-1-5-21-202424912787-2692429404-2351956786-1000' ]
13+
stability: experimental
14+
- id: authentication.role
15+
type: string
16+
stability: experimental
17+
brief: 'Actual/assumed role the client is making the request under extracted from token or application security context.'
18+
examples: 'admin'
19+
- id: authentication.scope
20+
type: string
21+
stability: experimental
22+
brief: >
23+
Scopes or granted authorities the client currently possesses extracted from token
24+
or application security context. The value would come from the scope associated
25+
with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3)
26+
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).
27+
examples: 'read:message, write:files'

model/enduser/common.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
groups:
2+
- id: enduser
3+
type: attribute_group
4+
brief: >
5+
This document defines attributes for Events represented using Log Records.
6+
attributes:
7+
- ref: enduser.id
8+
requirement_level: required
9+
- ref: enduser.authentication
10+
requirement_level: required

model/enduser/deprecated/common.yaml

Lines changed: 0 additions & 12 deletions
This file was deleted.

model/enduser/deprecated/registry-deprecated.yaml

Lines changed: 0 additions & 24 deletions
This file was deleted.

model/enduser/registry.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
groups:
3+
- id: registry.enduser
4+
type: attribute_group
5+
display_name: End User Attributes
6+
brief: >
7+
Describes information about the end user, which can be used as a sub-namespace of browser, client, or user domains.
8+
attributes:
9+
- id: enduser.id
10+
type: string
11+
stability: experimental
12+
brief: >
13+
Identifier of an end user who interacts with a system.
14+
This identifier may be unique only through best-effort means and does not imply that the user is authenticated to the system.
15+
examples: ['QdH5CAWJgqVT4rOr0qtumf']
16+
- id: enduser.authentication
17+
type: attribute_group
18+
stability: experimental
19+
brief: >
20+
Describes the authentication information of an authenticated end user.
21+
ref: registry.authentication

0 commit comments

Comments
 (0)