Skip to content

Commit cab8635

Browse files
committed
asim/add-user-scope
1 parent b514665 commit cab8635

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

articles/sentinel/normalization-about-schemas.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,15 @@ Each schema explicitly defines the central entities and entity fields. The follo
9999

100100
Users are central to activities reported by events. The fields listed in this section are used to describe the users involved in the action. Prefixes are used to designate the role of the user in the activity. The prefixes `Src` and `Dst` are used to designate the user role in network related events, in which a source system and a destination system communicate. The prefixes 'Actor' and 'Target' are used for system oriented events such as process events.
101101

102-
#### The user ID
102+
#### The user ID and scope
103103

104104
| Field | Class | Type | Description |
105105
|-------|-------|------|-------------|
106106
| <a name="userid"></a>**UserId** | Optional | String | A machine-readable, alphanumeric, unique representation of the user. |
107+
| <a name="userscope"></a>**UserScope** | Optional | string | The scope in which the user is defined. For example, an AAD tenant for. The scope type is tightly coupled to the user ID type, and therefore the [UserIdType](#useridtype) field represents also the type of the associated with this field. |
107108
| <a name="useridtype"></a>**UserIdType** | Optional | UserIdType | The type of the ID stored in the [UserId](#userid) field. |
108-
| **UserSid**, **UserUid**, **UserAadId**, **UserOktaId**, **UserAWSId** | Optional | String | Fields used to store additional user IDs, if the original event includes multiple user IDs. Select the ID most associated with the event as the primary ID stored in [UserId](#userid).
109+
| **UserSid**, **UserUid**, **UserAadId**, **UserOktaId**, **UserAWSId** | Optional | String | Fields used to store specific user IDs. Select the ID most associated with the event as the primary ID stored in [UserId](#userid). Populate the relevant specific ID field, in addition to [UserId](#userid), even if the event has only one ID. |
110+
| **UserSid**, **UserAWSAccount** | Optional | String | Fields used to store specific scopes. Use the [UserScope](#userscope) field for the scope associated with the ID stored in the [UserId](#userid) field. Populate the relevant specific scope field, in addition to [UserScope](#userscope), even if the event has only one ID. |
109111

110112
The allowed values for a user ID type are:
111113

@@ -117,6 +119,17 @@ The allowed values for a user ID type are:
117119
| **OktaId** | An Okta user ID. | `00urjk4znu3BcncfY0h7` |
118120
| **AWSId** | An AWS user ID. | `72643944673` |
119121

122+
#### The user scope
123+
124+
The user context defines the sc
125+
126+
| Field | Class | Type | Description |
127+
|-------|-------|------|-------------|
128+
| <a name="userscope"></a>**UserContext** | Optional | string | The context in which the user is defined
129+
| <a name="usercontexttype"></a>**UserContextType** | Optional | UserContextType | The type of the ID stored in the [UserId](#userid) field. |
130+
| **UserSid**, **UserUid**, **UserAadId**, **UserOktaId**, **UserAWSId** | Optional | String | Fields used to store additional user IDs, if the original event includes multiple user IDs. Select the ID most associated with the event as the primary ID stored in [UserId](#userid).
131+
132+
120133

121134
#### The user name
122135

0 commit comments

Comments
 (0)