Skip to content

unifiedrolemanagementalertconfiguration.md

Latest commit

 

History

History
77 lines (64 loc) · 4.54 KB

unifiedrolemanagementalertconfiguration.md

File metadata and controls

77 lines (64 loc) · 4.54 KB
title unifiedRoleManagementAlertConfiguration resource type
description An abstract type that exposes the tenant-specific configurations of a security alert that can be updated or modified in Privileged Identity Management (PIM) for Microsoft Entra roles.
author rkarim-ms
ms.localizationpriority medium
ms.subservice entra-id-governance
doc_type resourcePageType
toc.title Role management alert configuration
ms.date 07/22/2024

unifiedRoleManagementAlertConfiguration resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

An abstract type that exposes the tenant-specific configurations of a security alert that can be updated or modified in Privileged Identity Management (PIM) for Microsoft Entra roles.

This abstract type is inherited by the following derived types:

Inherits from entity.

For more information about working with security alerts for Microsoft Entra roles using PIM APIs, see Manage security alerts for Microsoft Entra roles using PIM APIs in Microsoft Graph.

Methods

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

Properties

Property Type Description
alertDefinitionId String The identifier of an alert definition. Supports $filter (eq, ne).
id String The identifier of the alert configuration. Inherited from entity.
isEnabled Boolean true if the alert is enabled. Setting it to false disables PIM scanning the tenant to identify instances that trigger the alert.
scopeId String The identifier of the scope to which the alert is related. Only / is supported to represent the tenant scope. 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.

Relationships

Relationship Type Description
alertDefinition unifiedRoleManagementAlertDefinition The definition of the alert that contains its description, impact, and measures to mitigate or prevent it. Supports $expand.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.unifiedRoleManagementAlertConfiguration",
  "id": "String (identifier)",
  "alertDefinitionId": "String",
  "scopeType": "String",
  "scopeId": "String",
  "isEnabled": "Boolean"
}

Related content