Skip to content

Latest commit

 

History

History
133 lines (104 loc) · 7.19 KB

File metadata and controls

133 lines (104 loc) · 7.19 KB
title Update unifiedRoleManagementAlertConfiguration
description Update the properties of an unifiedRoleManagementAlertConfiguration object.
author rkarim-ms
ms.localizationpriority medium
ms.subservice entra-id-governance
doc_type apiPageType
ms.date 04/05/2024
ms.custom sfi-ga-nochange

Update unifiedRoleManagementAlertConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of an alert configuration. The alert configuration can be one of the following types that are derived from the unifiedRoleManagementAlertConfiguration object:

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-pim-alerts-apis-write]

HTTP request

PATCH /identityGovernance/roleManagementAlerts/alertConfigurations/{unifiedRoleManagementAlertConfigurationId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

[!INCLUDE table-intro]

You must include the @odata.type property in the body of the request. The value for this property must be the same as the derived alert configuration type that you are updating. For example, if you are updating the tooManyGlobalAdminsAssignedToTenantAlertConfiguration alert configuration, the value for the @odata.type property must be #microsoft.graph.tooManyGlobalAdminsAssignedToTenantAlertConfiguration.

Property Type Description
duration Boolean The number of days to look back on from current timestamp.

Can be updated for the redundantAssignmentAlertConfiguration and the staleSignInAlertConfiguration alert configuration type.
globalAdminCountThreshold Int32 The threshold for the number of accounts assigned the Global Administrator role in the tenant. Triggers an alert if the number of global administrators in the tenant reaches or crosses this threshold value.

Can be updated for the tooManyGlobalAdminsAssignedToTenantAlertConfiguration alert configuration type.
isEnabled Boolean True if the alert is enabled. Setting to false will disable scanning for the specific alert. Optional.

Can be updated for all alert configuration types.
percentageOfGlobalAdminsOutOfRolesThreshold Int32 Threshold of the percentage of global administrators out of all the role assignments in the tenant. Triggers an alert if the percentage in the tenant reaches or crosses this threshold value.

Can be updated for the tooManyGlobalAdminsAssignedToTenantAlertConfiguration alert configuration type.
sequentialActivationCounterThreshold Int32 The minimum number of activations within the timeIntervalBetweenActivations period to trigger an alert.

Can be updated for the sequentialactivationrenewalsalertconfiguration alert configuration type.
timeIntervalBetweenActivations Duration Time interval between activations to trigger an alert.

Can be updated for the sequentialactivationrenewalsalertconfiguration alert configuration type.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/identityGovernance/roleManagementAlerts/alertConfigurations/DirectoryRole_67b47f38-0f0b-4e62-a3be-859140c2061f_TooManyGlobalAdminsAssignedToTenantAlert
Content-Type: application/json

{
  "@odata.type":"#microsoft.graph.tooManyGlobalAdminsAssignedToTenantAlertConfiguration",
  "isEnabled": "true",
  "globalAdminCountThreshold": 7,
  "percentageOfGlobalAdminsOutOfRolesThreshold": 70
}

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

HTTP/1.1 204 No Content