Update healthIssue

Namespace: microsoft.graph.security

Update the properties of a healthIssue object.

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)	SecurityIdentitiesHealth.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	SecurityIdentitiesHealth.ReadWrite.All	Not available.

HTTP request

PATCH /security/identities/healthIssues/{healthIssueId}

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
status	microsoft.graph.security.healthIssueStatus	The status of the health issue. The possible values are: open, closed, suppressed, unknownFutureValue.

Response

If successful, this method returns a 200 OK response code and an updated microsoft.graph.security.healthIssue object in the response body.

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/v1.0/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c
Content-Type: application/json

{
  "status": "closed"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models.Security;

var requestBody = new HealthIssue
{
	Status = HealthIssueStatus.Closed,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Identities.HealthIssues["{healthIssue-id}"].PatchAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc security identities health-issues patch --health-issue-id {healthIssue-id} --body '{\
  "status": "closed"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-sdk-go/models/security"
	  //other-imports
)

requestBody := graphmodelssecurity.NewHealthIssue()
status := graphmodels.CLOSED_HEALTHISSUESTATUS 
requestBody.SetStatus(&status) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
healthIssues, err := graphClient.Security().Identities().HealthIssues().ByHealthIssueId("healthIssue-id").Patch(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.HealthIssue healthIssue = new com.microsoft.graph.models.security.HealthIssue();
healthIssue.setStatus(com.microsoft.graph.models.security.HealthIssueStatus.Closed);
com.microsoft.graph.models.security.HealthIssue result = graphClient.security().identities().healthIssues().byHealthIssueId("{healthIssue-id}").patch(healthIssue);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const healthIssue = {
  status: 'closed'
};

await client.api('/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c')
	.update(healthIssue);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Security\HealthIssue;
use Microsoft\Graph\Generated\Models\Security\HealthIssueStatus;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new HealthIssue();
$requestBody->setStatus(new HealthIssueStatus('closed'));

$result = $graphServiceClient->security()->identities()->healthIssues()->byHealthIssueId('healthIssue-id')->patch($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Security

$params = @{
	status = "closed"
}

Update-MgSecurityIdentityHealthIssue -HealthIssueId $healthIssueId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.security.health_issue import HealthIssue
from msgraph.generated.models.health_issue_status import HealthIssueStatus
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = HealthIssue(
	status = HealthIssueStatus.Closed,
)

result = await graph_client.security.identities.health_issues.by_health_issue_id('healthIssue-id').patch(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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.type": "#microsoft.graph.security.healthIssue",
  "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"],
  "createdDateTime": "2022-07-15T12:19:27.7211305Z",
  "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com",
  "displayName": "Directory Services Object Auditing isn't configured as required",
  "domainNames": ["domain1.contoso.com", "domain2.contoso.com"],
  "healthIssueType": "Global",
  "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c",
  "issueTypeId": "1031",
  "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",
  "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"],
  "recommendedActionCommands": ["Import-Module DefenderForIdentity"],
  "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"],
  "severity": "medium",
  "status": "closed"
}