Create macOsVppApp

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

HTTP Request

POST /deviceAppManagement/mobileApps

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 macOsVppApp object.

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

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
usedLicenseCount Int32 The number of VPP licenses in use.
totalLicenseCount Int32 The total number of VPP licenses.
releaseDateTime DateTimeOffset The VPP application release date and time.
appStoreUrl String The store URL.
licensingType vppLicensingType The supported License Type.
vppTokenOrganizationName String The organization associated with the Apple Volume Purchase Program Token
vppTokenAccountType vppTokenAccountType The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: business, education. Possible values are: business, education.
vppTokenAppleId String The Apple Id associated with the given Apple Volume Purchase Program Token.
bundleId String The Identity Name.
vppTokenId String Identifier of the VPP token associated with this app.
revokeLicenseActionResults macOsVppAppRevokeLicensesActionResult collection Results of revoke license actions on this app.

Response

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

{
  "@odata.type": "#microsoft.graph.macOsVppApp",
  "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,
  "usedLicenseCount": 0,
  "totalLicenseCount": 1,
  "releaseDateTime": "2017-01-01T00:01:34.7470482-08:00",
  "appStoreUrl": "https://example.com/appStoreUrl/",
  "licensingType": {
    "@odata.type": "microsoft.graph.vppLicensingType",
    "supportUserLicensing": true,
    "supportDeviceLicensing": true,
    "supportsUserLicensing": true,
    "supportsDeviceLicensing": true
  },
  "vppTokenOrganizationName": "Vpp Token Organization Name value",
  "vppTokenAccountType": "education",
  "vppTokenAppleId": "Vpp Token Apple Id value",
  "bundleId": "Bundle Id value",
  "vppTokenId": "Vpp Token Id value",
  "revokeLicenseActionResults": [
    {
      "@odata.type": "microsoft.graph.macOsVppAppRevokeLicensesActionResult",
      "userId": "User Id value",
      "managedDeviceId": "Managed Device Id value",
      "totalLicensesCount": 2,
      "failedLicensesCount": 3,
      "actionFailureReason": "appleFailure",
      "actionName": "Action Name value",
      "actionState": "pending",
      "startDateTime": "2016-12-31T23:58:46.7156189-08:00",
      "lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
    }
  ]
}

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

{
  "@odata.type": "#microsoft.graph.macOsVppApp",
  "id": "10b95265-5265-10b9-6552-b9106552b910",
  "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,
  "usedLicenseCount": 0,
  "totalLicenseCount": 1,
  "releaseDateTime": "2017-01-01T00:01:34.7470482-08:00",
  "appStoreUrl": "https://example.com/appStoreUrl/",
  "licensingType": {
    "@odata.type": "microsoft.graph.vppLicensingType",
    "supportUserLicensing": true,
    "supportDeviceLicensing": true,
    "supportsUserLicensing": true,
    "supportsDeviceLicensing": true
  },
  "vppTokenOrganizationName": "Vpp Token Organization Name value",
  "vppTokenAccountType": "education",
  "vppTokenAppleId": "Vpp Token Apple Id value",
  "bundleId": "Bundle Id value",
  "vppTokenId": "Vpp Token Id value",
  "revokeLicenseActionResults": [
    {
      "@odata.type": "microsoft.graph.macOsVppAppRevokeLicensesActionResult",
      "userId": "User Id value",
      "managedDeviceId": "Managed Device Id value",
      "totalLicensesCount": 2,
      "failedLicensesCount": 3,
      "actionFailureReason": "appleFailure",
      "actionName": "Action Name value",
      "actionState": "pending",
      "startDateTime": "2016-12-31T23:58:46.7156189-08:00",
      "lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
    }
  ]
}