Edit

Update macOSPkgApp

Namespace: microsoft.graph

Important: Microsoft supports Intune /beta APIs, but they are subject to more frequent change. Microsoft recommends using version v1.0 when possible. Check an API's availability in version v1.0 using the Version selector.

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

Update the properties of a macOSPkgApp 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

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 least to most privileged)
Delegated (work or school account) DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementApps.ReadWrite.All

HTTP Request

PATCH /deviceAppManagement/mobileApps/{mobileAppId}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept application/json

Request body

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

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

Property Type Description
id String Key of the entity. This property is read-only. 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. This property is read-only. Inherited from mobileApp
lastModifiedDateTime DateTimeOffset The date and time the app was last modified. This property is read-only. 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. Possible values are: 0 - Not Ready, 1 - Ready, 2 - Processing. This property is read-only. Inherited from mobileApp
publishingState mobileAppPublishingState The publishing state for the app. The app cannot be assigned unless the app is published. This property is read-only. Inherited from mobileApp. Possible values are: notPublished, processing, published.
isAssigned Boolean The value indicating whether the app is assigned to at least one group. This property is read-only. 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. This property is read-only. Inherited from mobileApp
supersedingAppCount Int32 The total number of apps this app directly or indirectly supersedes. This property is read-only. Inherited from mobileApp
supersededAppCount Int32 The total number of apps this app is directly or indirectly superseded by. This property is read-only. Inherited from mobileApp
committedContentVersion String The internal committed content version. Inherited from mobileLobApp
fileName String The name of the main Lob application file. Inherited from mobileLobApp
size Int64 The total size, including all uploaded files. This property is read-only. Inherited from mobileLobApp
primaryBundleId String The bundleId of the primary app in the PKG. This maps to the CFBundleIdentifier in the app's bundle configuration.
primaryBundleVersion String The version of the primary app in the PKG. This maps to the CFBundleShortVersion in the app's bundle configuration.
includedApps macOSIncludedApp collection The list of apps expected to be installed by the PKG. This collection can contain a maximum of 500 elements.
ignoreVersionDetection Boolean When TRUE, indicates that the app's version will NOT be used to detect if the app is installed on a device. When FALSE, indicates that the app's version will be used to detect if the app is installed on a device. Set this to true for apps that use a self update feature. The default value is FALSE.
minimumSupportedOperatingSystem macOSMinimumOperatingSystem ComplexType macOSMinimumOperatingSystem that indicates the minimum operating system applicable for the application.
preInstallScript macOSAppScript ComplexType macOSAppScript the contains the post-install script for the app. This will execute on the macOS device after the app is installed.
postInstallScript macOSAppScript ComplexType macOSAppScript the contains the post-install script for the app. This will execute on the macOS device after the app is installed.

Response

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

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}
Content-type: application/json
Content-length: 1886

{
  "@odata.type": "#microsoft.graph.macOSPkgApp",
  "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,
  "supersedingAppCount": 3,
  "supersededAppCount": 2,
  "committedContentVersion": "Committed Content Version value",
  "fileName": "File Name value",
  "size": 4,
  "primaryBundleId": "Primary Bundle Id value",
  "primaryBundleVersion": "Primary Bundle Version value",
  "includedApps": [
    {
      "@odata.type": "microsoft.graph.macOSIncludedApp",
      "bundleId": "Bundle Id value",
      "bundleVersion": "Bundle Version value"
    }
  ],
  "ignoreVersionDetection": true,
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.macOSMinimumOperatingSystem",
    "v10_7": true,
    "v10_8": true,
    "v10_9": true,
    "v10_10": true,
    "v10_11": true,
    "v10_12": true,
    "v10_13": true,
    "v10_14": true,
    "v10_15": true,
    "v11_0": true,
    "v12_0": true,
    "v13_0": true,
    "v14_0": true,
    "v15_0": true,
    "v26_0": true
  },
  "preInstallScript": {
    "@odata.type": "microsoft.graph.macOSAppScript",
    "scriptContent": "Script Content value"
  },
  "postInstallScript": {
    "@odata.type": "microsoft.graph.macOSAppScript",
    "scriptContent": "Script Content 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: 2058

{
  "@odata.type": "#microsoft.graph.macOSPkgApp",
  "id": "fb6a88d3-88d3-fb6a-d388-6afbd3886afb",
  "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,
  "supersedingAppCount": 3,
  "supersededAppCount": 2,
  "committedContentVersion": "Committed Content Version value",
  "fileName": "File Name value",
  "size": 4,
  "primaryBundleId": "Primary Bundle Id value",
  "primaryBundleVersion": "Primary Bundle Version value",
  "includedApps": [
    {
      "@odata.type": "microsoft.graph.macOSIncludedApp",
      "bundleId": "Bundle Id value",
      "bundleVersion": "Bundle Version value"
    }
  ],
  "ignoreVersionDetection": true,
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.macOSMinimumOperatingSystem",
    "v10_7": true,
    "v10_8": true,
    "v10_9": true,
    "v10_10": true,
    "v10_11": true,
    "v10_12": true,
    "v10_13": true,
    "v10_14": true,
    "v10_15": true,
    "v11_0": true,
    "v12_0": true,
    "v13_0": true,
    "v14_0": true,
    "v15_0": true,
    "v26_0": true
  },
  "preInstallScript": {
    "@odata.type": "microsoft.graph.macOSAppScript",
    "scriptContent": "Script Content value"
  },
  "postInstallScript": {
    "@odata.type": "microsoft.graph.macOSAppScript",
    "scriptContent": "Script Content value"
  }
}
  • Last updated on