Create macOSDmgApp

Article
01/12/2023
4 minutes to read

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.

Create a new macOSDmgApp 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 least to most 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 macOSDmgApp object.

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

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. Possible values are: 0 - `Not Ready`, 1 - `Ready`, 2 - `Processing`. 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
supersedingAppCount	Int32	The total number of apps this app directly or indirectly supersedes. Inherited from mobileApp
supersededAppCount	Int32	The total number of apps this app is directly or indirectly superseded by. 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. Inherited from mobileLobApp
primaryBundleId	String	The primary CFBundleIdentifier of the DMG.
primaryBundleVersion	String	The primary CFBundleVersion of the DMG.
includedApps	macOSIncludedApp collection	The list of apps expected to be installed by the DMG.
ignoreVersionDetection	Boolean	A value indicating whether the app's version will be used to detect the app after it is installed on a device. Set this to true for apps that use a self-update feature. Set this to false to install the app when it is not already installed on the device, or if the deploying app's version number does not match the version that's already installed on the device.
minimumSupportedOperatingSystem	macOSMinimumOperatingSystem	The value for the minimum applicable operating system.

Response

If successful, this method returns a 201 Created response code and a macOSDmgApp 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: 1565

{
  "@odata.type": "#microsoft.graph.macOSDmgApp",
  "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
  }
}

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: 1737

{
  "@odata.type": "#microsoft.graph.macOSDmgApp",
  "id": "5f40a691-a691-5f40-91a6-405f91a6405f",
  "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
  }
}

Create macOSDmgApp

Permissions

HTTP Request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources

Additional resources