apple_device-management/mdm/profiles/com.apple.dock.yaml

title: Dock
description: The payload that configures the Dock.
payload:
  payloadtype: com.apple.dock
  supportedOS:
    iOS:
      introduced: n/a
    macOS:
      introduced: '10.7'
      multiple: false
      devicechannel: true
      userchannel: true
      supervised: false
      requiresdep: false
      userapprovedmdm: false
      allowmanualinstall: true
      userenrollment:
        mode: forbidden
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
payloadkeys:
- key: tilesize
  type: <integer>
  presence: optional
  range:
    min: 16
    max: 128
  content: The tile size. Values must be in the range from 16 to 128.
- key: size-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks the size slider.
- key: magnification
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, enables magnification.
- key: magnify-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks magnification.
- key: largesize
  type: <integer>
  presence: optional
  range:
    min: 16
    max: 128
  content: The size of the largest magnification.
- key: magsize-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks the magnification slider.
- key: orientation
  type: <string>
  presence: optional
  rangelist:
  - bottom
  - left
  - right
  content: The orientation of the Dock.
- key: position-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks the position.
- key: mineffect
  type: <string>
  presence: optional
  rangelist:
  - genie
  - scale
  content: The minimize effect.
- key: mineffect-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks "Minimize windows using."
- key: windowtabbing
  supportedOS:
    macOS:
      introduced: '10.15'
  type: <string>
  presence: optional
  rangelist:
  - manual
  - always
  - fullscreen
  content: Set the "Prefer tabs when opening documents" to the provided value.
- key: windowtabbing-immutable
  supportedOS:
    macOS:
      introduced: '10.12'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, disables "Prefer tabs when opening documents" checkbox.
- key: dblclickbehavior
  supportedOS:
    macOS:
      introduced: '10.15'
  type: <string>
  presence: optional
  rangelist:
  - minimize
  - maximize
  - none
  content: The behavior when the window's title bar is double-clicked.
- key: dblclickbehavior-immutable
  supportedOS:
    macOS:
      introduced: '10.14'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks "Double-click a window's title bar."
- key: minimize-to-application
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, enables "Minimize windows into application icon."
- key: minintoapp-immutable
  supportedOS:
    macOS:
      introduced: '10.14'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, disables the "Minimize windows into application icon" checkbox.
- key: launchanim
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, enables "Animate opening applications."
- key: launchanim-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks "Animate opening applications."
- key: autohide
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, enables "Automatically hide and show the Dock."
- key: autohide-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks "Automatically hide."
- key: show-process-indicators
  type: <boolean>
  presence: optional
  default: false
  content: If true, shows the process indicator.
- key: showindicators-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, locks "Show indicators."
- key: show-recents
  supportedOS:
    macOS:
      introduced: '10.14'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, enables "Show recent items."
- key: showrecents-immutable
  supportedOS:
    macOS:
      introduced: '10.15'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, disables "Show recent applications" checkbox.
- key: contents-immutable
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, disables changes to the Dock.
- key: MCXDockSpecialFolders
  type: <array>
  presence: optional
  content: |-
    One or more special folders that the device may create at user login time and place in the Dock.



    The "My Applications" item is only used for Simple Finder environments. The "Original Network Home" item is only used for mobile account users.
  subkeys:
  - key: MCXDockSpecialFoldersItems
    type: <string>
    rangelist:
    - AddDockMCXMyApplicationsFolder
    - AddDockMCXDocumentsFolder
    - AddDockMCXSharedFolder
    - AddDockMCXOriginalNetworkHomeFolder
- key: AllowDockFixupOverride
  supportedOS:
    macOS:
      introduced: '10.12'
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, use the file in `/Library/Preferences/com.apple.dockfixup.plist`
    when a new user or migrated user logs in. This option has no effect for existing
    users. Only available on the device channel.
- key: static-only
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, uses the `static-apps` and `static-others` dictionaries for
    the Dock and ignores any items in the `persistent-apps` and `persistent-others`
    dictionaries. If `false`, the contents are merged with the static items listed
    first.
- key: static-others
  type: <array>
  presence: optional
  content: An array of items located on the Documents side of the Dock that users
    can't remove from that location.
  subkeytype: StaticItem
  subkeys: &id001
  - key: StaticItem
    type: <dictionary>
    content: Items that are located on the Documents side of the Dock and cannot be
      removed from that location.
    subkeys:
    - key: tile-data
      type: <dictionary>
      presence: required
      content: The information about the Dock item.
      subkeys:
      - key: label
        type: <string>
        presence: required
        content: The label of the Dock item.
      - key: url
        type: <string>
        presence: optional
        content: The URL string.
      - key: file-type
        type: <integer>
        presence: required
        rangelist:
        - 0
        - 1
        - 3
        content: |-
          The type of tile:

          - `0`: URL
          - `1`: File
          - `3`: Directory
      - key: file-data
        type: <dictionary>
        presence: optional
        content: The data in a file. For Apple use only.
        subkeys:
        - key: ANY
          type: <any>
          presence: optional
          content: For Apple use only.
    - key: tile-type
      type: <string>
      presence: required
      rangelist:
      - file-tile
      - directory-tile
      - url-tile
      content: The type of tile.
- key: static-apps
  type: <array>
  presence: optional
  content: An array of items located on the Applications side of the Dock that users
    can't remove from that location.
  subkeytype: StaticItem
  subkeys: *id001
- key: persistent-apps
  type: <array>
  presence: optional
  content: An array of items located on the Applications side of the Dock that users
    can remove from the Dock.
  subkeytype: StaticItem
  subkeys: *id001
- key: persistent-others
  type: <array>
  presence: optional
  content: An array of items located on the Documents side of the Dock that users
    can remove from the Dock.
  subkeytype: StaticItem
  subkeys: *id001
examples:
- title: Profile example
  files:
  - file: examples/mdm/profiles/com.apple.dock/example1.plist