The properties common to all payloads.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
PayloadIdentifier PayloadIdentifier The reverse-DNS-style identifier for the payload. This identifier is usually the same as the `TopLevel` value, with an additional appended component. This string must be unique within the profile.
During a profile replacement, the system updates payloads with the same `PayloadIdentifier` and `PayloadUUID` in the old and new profiles. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadUUID PayloadUUID The globally unique identifier for the payload. The actual content is unimportant, but must be globally unique. In macOS, use `uuidgen` to generate UUIDs.
During a profile replacement, the system updates payloads with the same `PayloadIdentifier` and `PayloadUUID` in the old and new profiles. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadType PayloadType The payload type, which each payload domain's reference page specifies. | string | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadVersion PayloadVersion The version of this specific payload. | integer | required | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadDescription PayloadDescription The human-readable description of this payload. This description appears on the Detail screen. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadDisplayName PayloadDisplayName The human-readable name for the profile payload. The name appears on the Detail screen and doesn't need to be unique. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
PayloadOrganization PayloadOrganization The human-readable string containing the name of the organization that provides the profile. This value doesn't need to match the organization payload value in the enclosing dictionary. | string | optional | — | ✓Yes | iOS (4.0+)macOS (10.7+)tvOS (9.0+)visionOS (1.0+)watchOS (1.0+) |
