Update windowsOfficeClientSecurityConfiguration

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windowsOfficeClientSecurityConfiguration object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from most to least privileged)
Delegated (work or school account)	DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementConfiguration.ReadWrite.All

HTTP Request

PATCH /officeConfiguration/clientConfigurations/{officeClientConfigurationId}

Request headers

Header	Value
Authorization	Bearer <token> Required.
Accept	application/json

Request body

In the request body, supply a JSON representation for the windowsOfficeClientSecurityConfiguration object.

The following table shows the properties that are required when you create the windowsOfficeClientSecurityConfiguration.

Property	Type	Description
id	String	Id of the office client configuration policy. Inherited from officeClientConfiguration
userPreferencePayload	Stream	Preference settings JSON string in binary format, these values can be overridden by the user. Inherited from officeClientConfiguration
policyPayload	Stream	Policy settings JSON string in binary format, these values cannot be changed by the user. Inherited from officeClientConfiguration
description	String	Admin provided description of the office client configuration policy. Inherited from officeClientConfiguration
displayName	String	Admin provided name of the office client configuration policy. Inherited from officeClientConfiguration
assignments	officeClientConfigurationAssignment collection	The list of group assignments for the policy.. Inherited from officeClientConfiguration
priority	Int32	Priority value should be unique value for each policy under a tenant and will be used for conflict resolution, lower values mean priority is high. Inherited from officeClientConfiguration
lastModifiedDateTime	DateTime	Last modified datetime stamp of the policy. Inherited from officeClientConfiguration
userCheckinSummary	officeUserCheckinSummary	User check-in summary for the policy. Inherited from officeClientConfiguration
checkinStatuses	officeClientCheckinStatus collection	List of office Client check-in status. Inherited from officeClientConfiguration

Response

If successful, this method returns a 200 OK response code and an updated windowsOfficeClientSecurityConfiguration object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/officeConfiguration/clientConfigurations/{officeClientConfigurationId}
Content-type: application/json
Content-length: 949

{
  "userPreferencePayload": "<Unknown Primitive Type Edm.Stream>",
  "policyPayload": "<Unknown Primitive Type Edm.Stream>",
  "description": "Description value",
  "displayName": "Display Name value",
  "priority": 8,
  "userCheckinSummary": {
    "@odata.type": "microsoft.graph.officeUserCheckinSummary",
    "succeededUserCount": 2,
    "failedUserCount": 15
  },
  "checkinStatuses": [
    {
      "@odata.type": "microsoft.graph.officeClientCheckinStatus",
      "userPrincipalName": "User Principal Name value",
      "deviceName": "Device Name value",
      "devicePlatform": "Device Platform value",
      "devicePlatformVersion": "Device Platform Version value",
      "wasSuccessful": true,
      "userId": "User Id value",
      "checkinDateTime": "2016-12-31T23:56:33.9571764-08:00",
      "errorMessage": "Error Message value",
      "appliedPolicies": [
        "Applied Policies value"
      ]
    }
  ]
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.windowsOfficeClientSecurityConfiguration",
  "id": "f90ca1a5-a1a5-f90c-a5a1-0cf9a5a10cf9",
  "userPreferencePayload": "<Unknown Primitive Type Edm.Stream>",
  "policyPayload": "<Unknown Primitive Type Edm.Stream>",
  "description": "Description value",
  "displayName": "Display Name value",
  "priority": 8,
  "userCheckinSummary": {
    "@odata.type": "microsoft.graph.officeUserCheckinSummary",
    "succeededUserCount": 2,
    "failedUserCount": 15
  },
  "checkinStatuses": [
    {
      "@odata.type": "microsoft.graph.officeClientCheckinStatus",
      "userPrincipalName": "User Principal Name value",
      "deviceName": "Device Name value",
      "devicePlatform": "Device Platform value",
      "devicePlatformVersion": "Device Platform Version value",
      "wasSuccessful": true,
      "userId": "User Id value",
      "checkinDateTime": "2016-12-31T23:56:33.9571764-08:00",
      "errorMessage": "Error Message value",
      "appliedPolicies": [
        "Applied Policies value"
      ]
    }
  ]
}