Files
apple-device-management-mdm/mdm/commands/application.extensions.listactive.yaml
2025-09-15 20:38:03 -04:00

92 lines
2.9 KiB
YAML

title: Active NSExtensions Command
description: Get a list of active extensions for a user on a device.
payload:
requesttype: ActiveNSExtensions
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '10.13'
accessrights: QueryInstalledApps
devicechannel: false
userchannel: true
supervised: false
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: |-
Returns information about the active NSExtensions for a particular user.
NSExtensions are installed and enabled at the user level. There is no concept of "device" NSExtensions.
Requires "Query Installed Apps" right; supported on user channel only.
payloadkeys:
- key: FilterExtensionPoints
type: <array>
presence: optional
content: An array of extension points. If you choose to provide this value, the
response only includes the app extensions for the extension points you specify.
subkeys:
- key: FilterExtensionPointsItem
type: <string>
responsekeys:
- key: Extensions
type: <array>
presence: required
content: An array of dictionaries that contains information about active extensions
on the device.
subkeys:
- key: ExtensionsItem
type: <dictionary>
content: A dictionary that contains information about an extension.
subkeys:
- key: Identifier
type: <string>
presence: required
content: The identifier of the extension.
- key: ExtensionPoint
type: <string>
presence: required
content: The `NSExtensionPointIdentifier` for the extension.
- key: DisplayName
type: <string>
presence: required
content: The extension's display name.
- key: ContainerDisplayName
type: <string>
presence: optional
content: The display name of the container.
- key: ContainerIdentifier
type: <string>
presence: optional
content: The identifier of the container.
- key: Path
type: <string>
presence: required
content: The path to the extension.
- key: Version
type: <string>
presence: required
content: The version of the extension.
- key: UserElection
type: <string>
presence: required
rangelist:
- Default
- Use
- Ignore
content: The user-selected state of the extension, which a user sets in the
Extensions preference pane in System Preferences.
notes:
- title: ''
content: |-
This command returns information about the active extensions for a user. Extensions exist for each user, not for the device.
Extensions restricted from executing by Application Launch Restrictions or the `NSExtensionManagement` configuration profile won't appear in the response.
Refer to the following sections to determine supported channels and requirements, and to see an example request and response.