Skip to content

unifiedrolemanagementalertdefinition.md

Latest commit

 

History

History
72 lines (63 loc) · 4.01 KB

unifiedrolemanagementalertdefinition.md

File metadata and controls

72 lines (63 loc) · 4.01 KB
title unifiedRoleManagementAlertDefinition resource type
description Represents the alert definition that contains the description, impact, and measures to mitigate or prevent a security alert from being triggered in your tenant in PIM for Microsoft Entra roles.
author rkarim-ms
ms.localizationpriority medium
ms.subservice entra-id-governance
doc_type resourcePageType
toc.title Role management alert definition
ms.date 06/12/2024
ms.custom sfi-ga-nochange

unifiedRoleManagementAlertDefinition resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents the alert definition that contains the description, impact, and measures to mitigate or prevent a security alert from being triggered in your tenant in Privileged Identity Management (PIM) for Microsoft Entra roles.

Inherits from entity.

Methods

Method Return type Description
List unifiedRoleManagementAlertDefinition collection Get a list of the unifiedRoleManagementAlertDefinition objects and their properties.
Get unifiedRoleManagementAlertDefinition Read the properties and relationships of an unifiedRoleManagementAlertDefinition object.

Properties

Property Type Description
description String The description of the alert.
displayName String The friendly display name that renders in Privileged Identity Management (PIM) alerts in the Microsoft Entra admin center.
howToPrevent String Long-form text that indicates the ways to prevent the alert from being triggered in your tenant.
id String The identifier of the alert definition. Inherited from entity.
isConfigurable Boolean true if the alert configuration can be customized in the tenant, and false otherwise. For example, the number and percentage thresholds of the 'There are too many global administrators' alert can be configured by users, while the 'This organization doesn't have Microsoft Entra ID P2' can't be configured, because the criteria are restricted.
isRemediatable Boolean true if the alert can be remediated, and false otherwise.
mitigationSteps String The methods to mitigate the alert when it's triggered in the tenant. For example, to mitigate the 'There are too many global administrators', you could remove redundant privileged role assignments.
scopeId String The identifier of the scope where the alert is related. / is the only supported one for the tenant. Supports $filter (eq, ne).
scopeType String The type of scope where the alert is created. DirectoryRole is the only currently supported scope type for Microsoft Entra roles.
securityImpact String Security impact of the alert. For example, it could be information leaks or unauthorized access.
severityLevel alertSeverity Severity level of the alert. The possible values are: unknown, informational, low, medium, high, unknownFutureValue.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.unifiedRoleManagementAlertDefinition",
  "id": "String (identifier)",
  "displayName": "String",
  "scopeType": "String",
  "scopeId": "String",
  "description": "String",
  "severityLevel": "String",
  "securityImpact": "String",
  "mitigationSteps": "String",
  "howToPrevent": "String",
  "isRemediatable": "Boolean",
  "isConfigurable": "Boolean"
}