|
1 | 1 | ---
|
2 |
| -title: Microsoft Sentinel Authentication normalization schema reference | Microsoft Docs |
| 2 | +title: The Advanced Security Information Model (ASIM) Authentication normalization schema reference (Public preview) | Microsoft Docs |
3 | 3 | description: This article describes the Microsoft Sentinel Authentication normalization schema.
|
4 |
| -author: batamig |
| 4 | +author: oshezaf |
5 | 5 | ms.topic: reference
|
6 | 6 | ms.date: 11/09/2021
|
7 |
| -ms.author: bagol |
8 |
| -ms.custom: ignite-fall-2021 |
| 7 | +ms.author: ofshezaf |
9 | 8 | ---
|
10 | 9 |
|
11 |
| -# Microsoft Sentinel Authentication normalization schema reference (Public preview) |
| 10 | +# The Advanced Security Information Model (ASIM) Authentication normalization schema reference (Public preview) |
12 | 11 |
|
13 | 12 | [!INCLUDE [Banner for top of topics](./includes/banner.md)]
|
14 | 13 |
|
@@ -104,22 +103,41 @@ An **Actor**, running an acting Application, **ActingApp**, on a source system,
|
104 | 103 |
|
105 | 104 | In the following tables, *Type* refers to a logical type. For more information, see [Logical types](normalization-about-schemas.md#logical-types).
|
106 | 105 |
|
107 |
| -### Common fields |
| 106 | +### Common ASIM fields |
108 | 107 |
|
109 | 108 | > [!IMPORTANT]
|
110 |
| -> Fields common to all schemas are described in the [ASIM schema overview](normalization-about-schemas.md#common). The following list mentions only fields that have specific guidelines for user management events. |
| 109 | +> Fields common to all schemas are described in detail in the [ASIM Common Fields](normalization-common-fields.md) article. |
111 | 110 | >
|
112 | 111 |
|
| 112 | +#### Common fields with specific guidelines |
| 113 | + |
| 114 | +The following list mentions fields that have specific guidelines for authentication events: |
| 115 | + |
113 | 116 | | Field | Class | Type | Description |
|
114 | 117 | |---------------------|-------------|------------|--------------------|
|
115 | 118 | | **EventType** | Mandatory | Enumerated | Describes the operation reported by the record. <br><br>For Authentication records, supported values include: <br>- `Logon` <br>- `Logoff`|
|
116 |
| -| <a name ="eventresultdetails"></a>**EventResultDetails** | Optional | String | One of the following values: <br><br>- `No such user or password`. This value should be used also when the original event reports that there is no such user, without reference to a password. <br>- `Incorrect password`<br>- `Account expired`<br>- `Password expired`<br>- `User locked`<br>- `User disabled`<br>- `Logon violates policy`. This value should be used when the original event reports, for example: MFA required, logon outside of working hours, conditional access restrictions, or too frequent attempts.<br>- `Session expired`<br>- `Other`<br><br>**Note**: The value may be provided in the source record using different terms, which should be normalized to these values. The original value should be stored in the field [EventOriginalResultDetails](normalization-about-schemas.md#eventoriginalresultdetails)| |
117 |
| -| **EventSubType** | Optional | String | The sign-in type. Allowed values include: `System`, `Interactive`, `Service`, `RemoteInteractive`, `RemoteService`, `AssumeRole`. <br><br>Example: `Interactive`. Store the original value in [EventOriginalSubType](normalization-about-schemas.md#eventoriginalsubtype). | |
| 119 | +| <a name ="eventresultdetails"></a>**EventResultDetails** | Optional | String | One of the following values: <br><br>- `No such user or password`. This value should be used also when the original event reports that there is no such user, without reference to a password. <br>- `Incorrect password`<br>- `Account expired`<br>- `Password expired`<br>- `User locked`<br>- `User disabled`<br>- `Logon violates policy`. This value should be used when the original event reports, for example: MFA required, logon outside of working hours, conditional access restrictions, or too frequent attempts.<br>- `Session expired`<br>- `Other`<br><br>**Note**: The value may be provided in the source record using different terms, which should be normalized to these values. The original value should be stored in the field [EventOriginalResultDetails](normalization-common-fields.md#eventoriginalresultdetails)| |
| 120 | +| **EventSubType** | Optional | String | The sign-in type. Allowed values include: `System`, `Interactive`, `Service`, `RemoteInteractive`, `RemoteService`, `AssumeRole`. <br><br>Example: `Interactive`. Store the original value in [EventOriginalSubType](normalization-common-fields.md#eventoriginalsubtype). | |
118 | 121 | | **EventSchemaVersion** | Mandatory | String | The version of the schema. The version of the schema documented here is `0.1.1` |
|
119 |
| -| **EventSchema** | Mandatory | String | The name of the schema documented here is **Authentication**. | |
| 122 | +| **EventSchema** | Optional | String | The name of the schema documented here is **Authentication**. | |
120 | 123 | | **Dvc** fields| - | - | For authentication events, device fields refer to the system reporting the event. |
|
121 | 124 | | | | | |
|
122 | 125 |
|
| 126 | +> [!IMPORTANT] |
| 127 | +> The `EventSchema` field is currently optional but will become Mandatory on July 1st 2022. |
| 128 | +> |
| 129 | +
|
| 130 | +#### All common fields |
| 131 | + |
| 132 | +Fields that appear in the table below are common to all ASIM schemas. Any guideline specified above overrides the general guidelines for the field. For example, a field might be optional in general, but mandatory for a specific schema. For further details on each field, refer to the [ASIM Common Fields](normalization-common-fields.md) article. |
| 133 | + |
| 134 | +| **Class** | **Fields** | |
| 135 | +| --------- | ---------- | |
| 136 | +| Mandatory | - [EventCount](normalization-common-fields.md#eventcount)<br> - [EventStartTime](normalization-common-fields.md#eventstarttime)<br> - [EventEndTime](normalization-common-fields.md#eventendtime)<br> - [EventType](normalization-common-fields.md#eventtype)<br>- [EventResult](normalization-common-fields.md#eventresult)<br> - [EventProduct](normalization-common-fields.md#eventproduct)<br> - [EventVendor](normalization-common-fields.md#eventvendor)<br> - [EventSchema](normalization-common-fields.md#eventschema)<br> - [EventSchemaVersion](normalization-common-fields.md#eventschemaversion)<br> - [Dvc](normalization-common-fields.md#dvc)<br>| |
| 137 | +| Recommended | - [EventResultDetails](normalization-common-fields.md#eventresultdetails)<br>- [EventSeverity](normalization-common-fields.md#eventseverity)<br> - [DvcIpAddr](normalization-common-fields.md#dvcipaddr)<br> - [DvcHostname](normalization-common-fields.md#dvchostname)<br> - [DvcDomain](normalization-common-fields.md#dvcdomain)<br>- [DvcDomainType](normalization-common-fields.md#dvcdomaintype)<br>- [DvcFQDN](normalization-common-fields.md#dvcfqdn)<br>- [DvcId](normalization-common-fields.md#dvcid)<br>- [DvcIdType](normalization-common-fields.md#dvcidtype)<br>- [DvcAction](normalization-common-fields.md#dvcaction)| |
| 138 | +| Optional | - [EventMessage](normalization-common-fields.md#eventmessage)<br> - [EventSubType](normalization-common-fields.md#eventsubtype)<br>- [EventOriginalUid](normalization-common-fields.md#eventoriginaluid)<br>- [EventOriginalType](normalization-common-fields.md#eventoriginaltype)<br>- [EventOriginalSubType](normalization-common-fields.md#eventoriginalsubtype)<br>- [EventOriginalResultDetails](normalization-common-fields.md#eventoriginalresultdetails)<br> - [EventOriginalSeverity](normalization-common-fields.md#eventoriginalseverity) <br> - [EventProductVersion](normalization-common-fields.md#eventproductversion)<br> - [EventReportUrl](normalization-common-fields.md#eventreporturl)<br>- [DvcMacAddr](normalization-common-fields.md#dvcmacaddr)<br>- [DvcOs](normalization-common-fields.md#dvcos)<br>- [DvcOsVersion](normalization-common-fields.md#dvchostname)<br>- [DvcOriginalAction](normalization-common-fields.md#dvcoriginalaction)<br>- [DvcInterface](normalization-common-fields.md#dvcinterface)<br>- [AdditionalFields](normalization-common-fields.md#additionalfields)| |
| 139 | +||| |
| 140 | + |
123 | 141 |
|
124 | 142 | ### Authentication-specific fields
|
125 | 143 |
|
|
0 commit comments