Create officeSuiteApp

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.

Create a new officeSuiteApp object.

Prerequisites

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

HTTP Request

POST /deviceAppManagement/mobileApps

Request headers

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

Request body

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

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

Property Type Description
id String Key of the entity. Inherited from mobileApp
displayName String The admin provided or imported title of the app. Inherited from mobileApp
description String The description of the app. Inherited from mobileApp
publisher String The publisher of the app. Inherited from mobileApp
largeIcon mimeContent The large icon, to be displayed in the app details and used for upload of the icon. Inherited from mobileApp
createdDateTime DateTimeOffset The date and time the app was created. Inherited from mobileApp
lastModifiedDateTime DateTimeOffset The date and time the app was last modified. Inherited from mobileApp
isFeatured Boolean The value indicating whether the app is marked as featured by the admin. Inherited from mobileApp
privacyInformationUrl String The privacy statement Url. Inherited from mobileApp
informationUrl String The more information Url. Inherited from mobileApp
owner String The owner of the app. Inherited from mobileApp
developer String The developer of the app. Inherited from mobileApp
notes String Notes for the app. Inherited from mobileApp
uploadState Int32 The upload state. Inherited from mobileApp
publishingState mobileAppPublishingState The publishing state for the app. The app cannot be assigned unless the app is published. Inherited from mobileApp. Possible values are: notPublished, processing, published.
isAssigned Boolean The value indicating whether the app is assigned to at least one group. Inherited from mobileApp
roleScopeTagIds String collection List of scope tag ids for this mobile app. Inherited from mobileApp
dependentAppCount Int32 The total number of dependencies the child app has. Inherited from mobileApp
autoAcceptEula Boolean The value to accept the EULA automatically on the enduser's device.
productIds officeProductId collection The Product Ids that represent the Office365 Suite SKU. Possible values are: o365ProPlusRetail, o365BusinessRetail, visioProRetail, projectProRetail.
excludedApps excludedApps The property to represent the apps which are excluded from the selected Office365 Product Id.
useSharedComputerActivation Boolean The property to represent that whether the shared computer activation is used not for Office365 app suite.
updateChannel officeUpdateChannel The property to represent the Office365 Update Channel. Possible values are: none, current, deferred, firstReleaseCurrent, firstReleaseDeferred.
officePlatformArchitecture windowsArchitecture The property to represent the Office365 app suite version. Possible values are: none, x86, x64, arm, neutral, arm64.
localesToInstall String collection The property to represent the locales which are installed when the apps from Office365 is installed. It uses standard RFC 6033. Ref: https://technet.microsoft.com/en-us/library/cc179219(v=office.16).aspx|
installProgressDisplayLevel officeSuiteInstallProgressDisplayLevel To specify the level of display for the Installation Progress Setup UI on the Device. Possible values are: none, full.
shouldUninstallOlderVersionsOfOffice Boolean The property to determine whether to uninstall existing Office MSI if an Office365 app suite is deployed to the device or not.
targetVersion String The property to represent the specific target version for the Office365 app suite that should be remained deployed on the devices.
updateVersion String The property to represent the update version in which the specific target version is available for the Office365 app suite.
officeConfigurationXml Binary The property to represent the XML configuration file that can be specified for Office ProPlus Apps. Takes precedence over all other properties. When present, the XML configuration file will be used to create the app.

Response

If successful, this method returns a 201 Created response code and a officeSuiteApp object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps
Content-type: application/json
Content-length: 1599

{
  "@odata.type": "#microsoft.graph.officeSuiteApp",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "uploadState": 11,
  "publishingState": "processing",
  "isAssigned": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "dependentAppCount": 1,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": true,
    "excel": true,
    "groove": true,
    "infoPath": true,
    "lync": true,
    "oneDrive": true,
    "oneNote": true,
    "outlook": true,
    "powerPoint": true,
    "publisher": true,
    "sharePointDesigner": true,
    "teams": true,
    "visio": true,
    "word": true
  },
  "useSharedComputerActivation": true,
  "updateChannel": "current",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}

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 201 Created
Content-Type: application/json
Content-Length: 1771

{
  "@odata.type": "#microsoft.graph.officeSuiteApp",
  "id": "9b263b46-3b46-9b26-463b-269b463b269b",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "uploadState": 11,
  "publishingState": "processing",
  "isAssigned": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "dependentAppCount": 1,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": true,
    "excel": true,
    "groove": true,
    "infoPath": true,
    "lync": true,
    "oneDrive": true,
    "oneNote": true,
    "outlook": true,
    "powerPoint": true,
    "publisher": true,
    "sharePointDesigner": true,
    "teams": true,
    "visio": true,
    "word": true
  },
  "useSharedComputerActivation": true,
  "updateChannel": "current",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}