apple_device-management/mdm/profiles/com.apple.webClip.managed.yaml

title: Web Clip
description: The profile that configures web clips on the device.
payload:
  payloadtype: com.apple.webClip.managed
  supportedOS:
    iOS:
      introduced: '4.0'
      multiple: true
      supervised: false
      allowmanualinstall: true
      sharedipad:
        mode: allowed
        devicechannel: false
        userchannel: true
      userenrollment:
        mode: allowed
    macOS:
      introduced: '10.7'
      multiple: true
      devicechannel: false
      userchannel: true
      supervised: false
      requiresdep: false
      userapprovedmdm: false
      allowmanualinstall: true
      userenrollment:
        mode: allowed
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
payloadkeys:
- key: Precomposed
  title: Precomposed icon
  supportedOS:
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system prevents SpringBoard from adding shine to the icon.
- key: FullScreen
  title: Full screen
  supportedOS:
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, the system launches the web clip as a full-screen web app.
- key: URL
  title: URL
  type: <string>
  subtype: <url>
  presence: required
  content: The URL of the web clip.
- key: Icon
  title: Icon
  type: <data>
  presence: optional
  content: The PNG icon to show on the Home Screen. If not set, the system displays
    a white square. For best results, provide a square image that's no larger than
    400 x 400 pixels and less than 1 MB when uncompressed. The graphics file is automatically
    scaled and cropped to fit, if necessary, and converted to PNG format. Web clip
    icons are 144 x 144 pixels for iPad devices with a Retina display, and 114 x 114
    pixels for iPhone devices. To prevent the device from adding a shine to the image,
    set `Precomposed` to `true`.
- key: IsRemovable
  title: Removable
  supportedOS:
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: true
  content: If `true`, the system enables removing the web clip.
- key: Label
  title: Label
  type: <string>
  presence: required
  content: The name of the web clip that the system displays on the Home Screen.
- key: IgnoreManifestScope
  title: Ignore web clip manifest scope
  supportedOS:
    iOS:
      introduced: '14.0'
    macOS:
      introduced: n/a
  type: <boolean>
  presence: optional
  default: false
  content: If `true`, a full screen web clip can navigate to an external web site
    without showing Safari UI. Otherwise, Safari UI appears when navigating away from
    the web clip's URL. This key has no effect when `FullScreen` is `false`.
- key: TargetApplicationBundleIdentifier
  title: Target application bundle identifier
  supportedOS:
    iOS:
      introduced: '14.0'
      allowmanualinstall: false
    macOS:
      introduced: n/a
  type: <string>
  presence: optional
  content: The application bundle identifier of the application that opens the URL.
    To use this property, install the profile through MDM.
notes:
- title: ''
  content: |-
    Use this payload to add web clips to the Home Screen of the user's iOS device or to the Dock on a Mac. Web clips provide fast access to favorite webpages.

    For iOS devices, if you prevent the user from removing the web clip, the only way to remove it is to remove the configuration profile that installed it. Also, for iOS devices it must have a display name and an icon URL for the payload to be valid.

    A full-screen web clip on iOS devices opens the URL as a web app without a browser; there's no URL, search bar, or bookmarks.

    For Shared iPad devices, the system supports this payload on the user channel only.
examples:
- title: Profile example
  files:
  - file: examples/mdm/profiles/com.apple.webClip.managed/example1.plist