Contents

CommonPayloadKeys

The properties common to all payloads.

Declaration

object CommonPayloadKeys

Properties

NameTypeDescription
PayloadDescriptionstring

The human-readable description of this payload. This description appears on the Detail screen.

PayloadDisplayNamestring

The human-readable name for the profile payload. The name appears on the Detail screen and doesn’t need to be unique.

PayloadIdentifier Requiredstring

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.

PayloadOrganizationstring

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.

PayloadType Requiredstring

The payload type, which each payload domain’s reference page specifies.

PayloadUUID Requiredstring

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.

PayloadVersion Requiredinteger

The version of this specific payload.

Discussion

Profile availability

Device channel

iOS, macOS, Shared iPad, tvOS, visionOS, watchOS

User channel

macOS, Shared iPad

Allow manual install

iOS, macOS, tvOS, visionOS, watchOS

Requires supervision

NA

Requires user-approved MDM

NA

Allowed in user enrollment

iOS, macOS, visionOS

Allow multiple payloads

NA

See Also

Top Level