Edit

impactedResource: removeTag (for multiple resources)

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Remove the same user-defined tag from multiple impactedResource objects in a single request. To remove a tag from a single impacted resource, use the removeTag action instead.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) DirectoryRecommendations.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application DirectoryRecommendations.ReadWrite.All Not available.

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. This operation supports the following built-in roles, which provide only the least privilege necessary:

  • Security Administrator
  • Security Operator
  • Application Administrator
  • Cloud Application Administrator

HTTP request

POST /directory/recommendations/{recommendationId}/impactedResources/removeTag

Request headers

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

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that you can use with this action.

Parameter Type Description
resourceIds String collection The identifiers of the impactedResource objects to remove the tag from. A maximum of 50 resource IDs can be supplied per request. Required.
displayName String The free-form label text of the tag to remove from each impacted resource. Required.

If more than 50 resource IDs are supplied, the request fails with a 400 Bad Request response and an invalidRequest error.

Response

If successful, this action returns a 200 OK response code and an impactedResource collection in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/directory/recommendations/0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.ApplicationCredentialExpiry/impactedResources/removeTag
Content-Type: application/json

{
    "resourceIds": [
        "dbd9935e-15b7-4800-9049-8d8704c23ad2",
        "8f421b3d-6d33-4f2a-9d6f-7c2f1a9e5b10"
    ],
    "displayName": "Q3 remediation"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(impactedResource)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.impactedResource",
      "id": "dbd9935e-15b7-4800-9049-8d8704c23ad2",
      "recommendationId": "0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.ApplicationCredentialExpiry",
      "displayName": "Contoso IWA App Tutorial"
    },
    {
      "@odata.type": "#microsoft.graph.impactedResource",
      "id": "8f421b3d-6d33-4f2a-9d6f-7c2f1a9e5b10",
      "recommendationId": "0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.ApplicationCredentialExpiry",
      "displayName": "Fabrikam Web App"
    }
  ]
}