officeClientConfiguration resource type

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.

Office Client Configuration.

Methods

Method	Return Type	Description
List officeClientConfigurations	officeClientConfiguration collection	List properties and relationships of the officeClientConfiguration objects.
Get officeClientConfiguration	officeClientConfiguration	Read properties and relationships of the officeClientConfiguration object.
assign action	officeClientConfigurationAssignment collection	Replace all targeted groups for a policy.
updatePriorities action	None	Update policy priorities.

Properties

Property	Type	Description
id	String	Id of the office client configuration policy.
userPreferencePayload	Stream	Preference settings JSON string in binary format, these values can be overridden by the user.
policyPayload	Stream	Policy settings JSON string in binary format, these values cannot be changed by the user.
description	String	Not yet documented
displayName	String	Admin provided description of the office client configuration policy.
lastModifiedDateTime	DateTime	Last modified datetime stamp of the policy.
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.
userCheckinSummary	officeUserCheckinSummary	User check-in summary for the policy.
checkinStatuses	officeClientCheckinStatus collection	List of office Client check-in status.

Relationships

Relationship	Type	Description
assignments	officeClientConfigurationAssignment collection	The list of group assignments for the policy.

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.officeClientConfiguration",
  "id": "String (identifier)",
  "userPreferencePayload": "<Unknown Primitive Type Edm.Stream>",
  "policyPayload": "<Unknown Primitive Type Edm.Stream>",
  "description": "String",
  "displayName": "String",
  "priority": 1024,
  "userCheckinSummary": {
    "@odata.type": "microsoft.graph.officeUserCheckinSummary",
    "succeededUserCount": 1024,
    "failedUserCount": 1024
  },
  "checkinStatuses": [
    {
      "@odata.type": "microsoft.graph.officeClientCheckinStatus",
      "userPrincipalName": "String",
      "deviceName": "String",
      "devicePlatform": "String",
      "devicePlatformVersion": "String",
      "wasSuccessful": true,
      "userId": "String",
      "checkinDateTime": "String (timestamp)",
      "errorMessage": "String",
      "appliedPolicies": [
        "String"
      ]
    }
  ]
}