diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index 35356a67cb..4e21e23c16 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -34,6 +34,7 @@ Currently, the following namespaces exist: - [Android](android.md) - [Artifact](artifact.md) - [Aspnetcore](aspnetcore.md) +- [Authentication](authentication.md) - [AWS](aws.md) - [Azure](azure.md) - [Browser](browser.md) diff --git a/docs/attributes-registry/authentication.md b/docs/attributes-registry/authentication.md new file mode 100644 index 0000000000..7fc50f4539 --- /dev/null +++ b/docs/attributes-registry/authentication.md @@ -0,0 +1,17 @@ + + + + + +# Authentication + +## Authentication Attributes + +"Describes the authentication information of an authenticated user." + +| Attribute | Type | Description | Examples | Stability | +| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------- | +| `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) | +| `authentication.role` | string | Actual/assumed role the client is making the request under extracted from token or application security context. | `admin` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `authentication.scope` | 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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/attributes-registry/enduser.md b/docs/attributes-registry/enduser.md index db2d7a5835..3a674523e0 100644 --- a/docs/attributes-registry/enduser.md +++ b/docs/attributes-registry/enduser.md @@ -6,12 +6,11 @@ # Enduser -## Deprecated End User Attributes +## End User Attributes -Describes deprecated enduser attributes. Complete enduser namespace has been deprecated +Describes information about the end user, which can be used as a subdomain of browser, client, or user domains. -| Attribute | Type | Description | Examples | Stability | -| --------------- | ------ | ---------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------- | -| `enduser.id` | string | Deprecated, use `user.id` instead. | `username` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user.id` attribute. | -| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user.roles` attribute. | -| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. | +| Attribute | Type | Description | Examples | Stability | +| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | ---------------------------------------------------------------- | +| `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) | +| `enduser.id` | string | Identifier of an end 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. | `QdH5CAWJgqVT4rOr0qtumf` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |