apple_device-management/mdm/profiles/com.apple.app.lock.yaml

title: App Lock
description: The payload that configures a device to run a single app.
payload:
  payloadtype: com.apple.app.lock
  supportedOS:
    iOS:
      introduced: '6.0'
      multiple: false
      supervised: true
      allowmanualinstall: true
      sharedipad:
        mode: allowed
        devicechannel: true
        userchannel: false
      userenrollment:
        mode: forbidden
    macOS:
      introduced: n/a
    tvOS:
      introduced: '10.2'
      multiple: false
      supervised: true
      allowmanualinstall: true
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
payloadkeys:
- key: App
  title: App
  type: <dictionary>
  presence: required
  content: A dictionary that contains information about the app.
  subkeys:
  - key: Identifier
    title: Identifier
    type: <string>
    presence: required
    content: The app's bundle identifier.
  - key: Options
    title: Options
    supportedOS:
      iOS:
        introduced: '7.0'
    type: <dictionary>
    presence: optional
    content: A dictionary of options that the user can't change.
    subkeys:
    - key: DisableTouch
      title: Disable touch
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system disables the touch screen. In tvOS, it disables
        the touch surface on the Apple TV Remote.
    - key: DisableDeviceRotation
      title: Disable device rotation
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system disables device rotation sensing.
    - key: DisableVolumeButtons
      title: Disable volume buttons
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system disables the volume buttons.
    - key: DisableRingerSwitch
      title: Disable ringer switch
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system disables the ringer switch. When disabled, the
        ringer behavior depends on what position the switch was in when it was first
        disabled.
    - key: DisableSleepWakeButton
      title: Disable sleep wake button
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system disables the sleep/wake button.
    - key: DisableAutoLock
      title: Disable auto lock
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the device doesn't automatically go to sleep after an idle
        period.
    - key: EnableVoiceOver
      title: Enable VoiceOver
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables VoiceOver.
    - key: EnableZoom
      title: Enable Zoom
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables Zoom.
    - key: EnableInvertColors
      title: Enable Invert Colors
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables Invert Colors.
    - key: EnableAssistiveTouch
      title: Enable AssistiveTouch
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables AssistiveTouch.
    - key: EnableSpeakSelection
      title: Enable Speak Selection
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables Speak Selection.
    - key: EnableMonoAudio
      title: Enable Mono Audio
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables Mono Audio.
    - key: EnableVoiceControl
      title: Enable Voice Control
      supportedOS:
        iOS:
          introduced: '13.0'
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables Voice Control.
  - key: UserEnabledOptions
    title: User enabled options
    supportedOS:
      iOS:
        introduced: '7.0'
    type: <dictionary>
    presence: optional
    content: A dictionary of user-editable options.
    subkeys:
    - key: VoiceControl
      title: Voice Control
      supportedOS:
        iOS:
          introduced: '13.0'
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system allows the user to toggle Voice Control.
    - key: VoiceOver
      title: VoiceOver
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system allows the user to toggle VoiceOver.
    - key: Zoom
      title: Zoom
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system allows the user to toggle Zoom.
    - key: InvertColors
      title: Invert Colors
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system allows the user to toggle Invert Colors.
    - key: AssistiveTouch
      title: AssistiveTouch
      supportedOS:
        tvOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system allows the user to toggle AssistiveTouch.
notes:
- title: ''
  content: |-
    With an app lock profile, the device locks to the specified app until removal of the profile. The device returns to the app automatically upon wake or restart.

    Only use an app lock payload after installing the target app.
examples:
- title: Profile example
  files:
  - file: examples/mdm/profiles/com.apple.app.lock/example1.plist