apple_device-management/mdm/commands/application.managed.list.yaml

title: Managed Application List Command
description: Get the status of all managed apps on a device.
payload:
  requesttype: ManagedApplicationList
  supportedOS:
    iOS:
      introduced: '5.0'
      accessrights: AllowAppInstallation
      supervised: false
      requiresdep: false
      sharedipad:
        mode: allowed
        devicechannel: true
        userchannel: false
      userenrollment:
        mode: allowed
    macOS:
      introduced: '11.0'
      accessrights: AllowAppInstallation
      devicechannel: true
      userchannel: true
      supervised: false
      requiresdep: false
      userenrollment:
        mode: allowed
    tvOS:
      introduced: '10.2'
      accessrights: AllowAppInstallation
      supervised: false
    visionOS:
      introduced: '1.1'
      accessrights: AllowAppInstallation
      supervised: false
      requiresdep: false
      userenrollment:
        mode: allowed
    watchOS:
      introduced: '10.0'
      accessrights: AllowAppInstallation
      supervised: false
payloadkeys:
- key: Identifiers
  supportedOS:
    iOS:
      introduced: '7.0'
  type: <array>
  presence: optional
  content: |-
    The bundle identifiers of the managed apps to include in the response.

    > Important:
    > For a watchOS app, the identifier needs to be the watch's bundle identifier, which differs from the main bundle identifier for the iPhone the watch pairs with. Obtain the watch's bundle identifier for an app with a watch bundle, in the `watchBundleId` key that's part of the Content Metadata query. For more information on this query, see `Getting app and book information (Legacy)`.
  subkeys:
  - key: IdentifiersItem
    type: <string>
responsekeys:
- key: ManagedApplicationList
  type: <dictionary>
  presence: required
  content: A dictionary that contains status information about each managed app. The
    response doesn't include apps that Declarative Device Management manages.
  subkeytype: ManagedApplicationListItem
  subkeys:
  - key: ANY app identifier
    type: <dictionary>
    presence: required
    content: The bundle identifier of the managed app.
    subkeytype: ManagedApplicationItem
    subkeys:
    - key: Status
      type: <string>
      presence: required
      rangelist:
      - Queued
      - NeedsRedemption
      - Redeeming
      - Prompting
      - PromptingForLogin
      - ValidatingPurchase
      - PromptingForUpdate
      - PromptingForUpdateLogin
      - PromptingForManagement
      - ValidatingUpdate
      - Updating
      - Installing
      - Managed
      - ManagedButUninstalled
      - Unknown
      - UserInstalledApp
      - UserRejected
      - UpdateRejected
      - ManagementRejected
      - Failed
      content: |-
        The status of the managed app, which is one of the following values:

        - `Queued`: The app is scheduled for installation.
        - `NeedsRedemption`: The app needs a redemption code to complete installation.
        - `Redeeming`: The device is redeeming the redemption code for the app.
        - `Prompting`: The app installation is prompting the user.
        - `PromptingForLogin' - The app installation is prompting the user for App Store credentials.
        - `ValidatingPurchase`: Validation of the app purchase is occurring.
        - `PromptingForUpdate`: An app update is prompting the user.
        - `PromptingForUpdateLogin`: An app update is prompting the user for App Store credentials.
        - `PromptingForManagement`: Changing the app to a managed app is prompting the user.
        - `ValidatingUpdate`: Validation of an app update is occurring.
        - `Updating`: The app is updating.
        - `Installing`: The app is installing.
        - `Managed`: The installed app is a managed app.
        - `ManagedButUninstalled`: The app is a managed app and the user removed it. Reinstalling the app reinstates it as a managed app.
        - `Unknown`: The app state is unknown.

        The following statuses are transient and report only once:

        - `UserInstalledApp`: The user installed the app before managed app installation could occur.
        - `UserRejected`: The user rejected the offer to install the app.
        - `UpdateRejected`: The user rejected the offer to update the app.
        - `ManagementRejected`:The user rejected management of an installed app.
        - `Failed`: The app installation failed.
    - key: ManagementFlags
      type: <integer>
      presence: required
      content: |-
        The bitwise OR of the following management flags:
        * '1': Remove app upon removal of MDM profile.
        * '4': Prevent backup of app data.
    - key: UnusedRedemptionCode
      supportedOS:
        macOS:
          introduced: n/a
        tvOS:
          introduced: n/a
      type: <string>
      presence: required
      content: If the user already purchased a paid app, this code is available for
        use by another user. This code reports only once.
    - key: HasConfiguration
      supportedOS:
        iOS:
          introduced: '7.0'
        macOS:
          introduced: '11.0'
      type: <boolean>
      presence: required
      content: If 'true', the app has a server-provided managed configuration.
    - key: HasFeedback
      supportedOS:
        iOS:
          introduced: '7.0'
        macOS:
          introduced: '11.3'
          devicechannel: false
      type: <boolean>
      presence: required
      content: If 'true', the app has feedback for the server. On macOS 11.3 and later,
        this value is available if the device management server sent the request on
        the user channel.
    - key: IsValidated
      supportedOS:
        iOS:
          introduced: '9.2'
        macOS:
          introduced: n/a
      type: <boolean>
      presence: required
      content: If 'true', the app is valid and can run on the device. If the app is
        enterprise-distributed and unvalidated, it won't be able to run until validation
        has occurred.
    - key: ExternalVersionIdentifier
      supportedOS:
        iOS:
          introduced: '10.3'
        macOS:
          introduced: '11.3'
        tvOS:
          introduced: '10.2'
      type: <integer>
      presence: required
      content: |-
        The app's external version identifier. You can also retrieve this value from the App Store. For more information, see `Apps and books metadata for organizations`.

        If the current external version identifier of an app on the App Store doesn't match the external version identifier reported by the device, there may be an app update available for the device.

        > Note:
        > A newer version of an app might not be available for installation on the device for a variety of reasons. A common reason is that the device's operating system version or hardware is incompatible with the available version of the app.
notes:
- title: ''
  content: |-
    This command returns the status of managed apps from the App Store.

    Some statuses are transient and the device removes them after reporting them to the server.

    This command doesn't return apps that Declarative Device Management is managing.

    Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
examples:
- title: Example request and response
  files:
  - request-file: examples/mdm/commands/application.managed.list/example1.plist
    response-file: examples/mdm/commands/application.managed.list/example2.plist