Education Configuration
com.apple.education
The payload that configures the users, groups, and departments within an educational organization.
Only one instance per profile · macOS: user channel only
Configuration Keys (12)
Showing 12 of 12 keys
| Key | Type | Description | Default | Range |
|---|---|---|---|---|
| string | The organization's display name. The system displays this name in the iOS login screen. | Default: — | Range: — | |
| string | The organization's UUID identifier. This identifier can be any valid UUID. All teacher and student devices that need to communicate with one another must have the same organization UUID, particularly if they originated from different Device Enrollment Programs. | Default: — | Range: — | |
| string | The UUID of an identity certificate payload within the same profile to use for performing client authentication with other devices. This property supports PKCS12 certificates. Required to configure Classroom. Has no effect on the configuration of the Shared iPad login screen. | Default: — | Range: — | |
| array | For Shared iPad profiles: The array of dictionaries that defines which groups the user can select in the Login Window. For leader/teacher profiles: The array of dictionaries that defines the groups that the user can control. For member/student profiles: The array of dictionaries that defines the groups where the user is a member. | Default: — | Range: — | |
GroupsItemdictGroupsDictionary | dict | An array of dictionaries defining groups. | Default: — | Range: — |
| integer | An unsigned 16 bit integer specifying this group's unique beacon ID. | Default: — | Range: — | |
| string | The display name of the group. | Default: — | Range: — | |
DescriptionstringGroup Description | string | The description of the group. | Default: — | Range: — |
| string | Deprecated in iOS 9.3.1 and later. The URL of an image for the group. | Default: — | Range: — | |
ConfigurationSourcestringConfiguration Source | string | The source that provided this group, such as SIS, or MDM. | Default: — | Range: — |
LeaderIdentifiersarrayLeader Identifiers | array | The user identifiers that are leaders of this group. | Default: — | Range: — |
| string | A user identifier. | Default: — | Range: — | |
| array | The entries in the Users array that are members of the group. | Default: — | Range: — | |
| string | A member identifier. | Default: — | Range: — | |
| array | The identifiers that refer to entries in the 'DeviceGroups' array to which the instructor can assign users from this class. Has no effect on the configuration of the Shared iPad login screen. | Default: — | Range: — | |
| string | A device group identifier. | Default: — | Range: — | |
| array | For Shared iPad profiles: The array of dictionaries that define the users that the system displays in the iOS Login Window. For leader/teacher profiles: The array of dictionaries that define users that are members of the teacher's groups. For member/student profiles: The array of dictionaries that needs to contain the definition of the user specified in the 'UserIdentifier' key. With one-to-one member devices, this key should include only the device user and the teacher but not other class members. | Default: — | Range: — | |
UsersItemdictUsersDictionary | dict | A user in the organization. | Default: — | Range: — |
| string | The unique identifier for a user in the organization. | Default: — | Range: — | |
| string | The name of the user. | Default: — | Range: — | |
GivenNamestringGiven Name | string | The given name of the user. | Default: — | Range: — |
FamilyNamestringFamily Name | string | The family name of the user. | Default: — | Range: — |
PhoneticGivenNamestringPhonetic Given Name | string | The user's phonetic given name. The system uses this name to sort users in the Classroom app and the Shared iPad Login Screen. | Default: — | Range: — |
PhoneticFamilyNamestringPhonetic Family Name | string | The user's phonetic family name. The system uses this name to sort users in the Classroom app and the Shared iPad login screen. | Default: — | Range: — |
ImageURLstringImage URL | string | A string that contains a URL pointing to an image of the user. The system displays this image in the iOS login screen and in the Classroom app. The recommended resolution is 256 x 256 pixels (512 x 512 pixels on a 2x device). The recommended formats are JPEG, PNG, and TIFF. The system uses the 'ResourcePayloadCertificateUUID' identity certificate or the MDM client identity to perform authentication when fetching the image. | Default: — | Range: — |
| string | Deprecated in iOS 9.3.1 and later. The URL pointing to an image of the user. The system uses the 'ResourcePayloadCertificateUUID' identity certificate or the MDM client identity to perform authentication when fetching the specified resource. | Default: — | Range: — | |
AppleIDstringApple ID | string | The Managed Apple Account for this user. Not required to configure Classroom, but if set the system uses it. Required to configure the Shared iPad login screen. | Default: — | Range: — |
PasscodeTypestringPasscode Type | string | The type of passcode UI to show when the user is at the Login Window. | Default: — | Range: complex, four, six |
Leader Payload Certificate Anchor UUIDs | array | The array of UUIDs referring to certificate payloads within the same profile that the system uses to authorize leader peer certificate identities. This array needs to contain all necessary certificates to validate the entire chain of trust. Leader certificates needs to have the common name prefix leader, which is case insensitive. This property doesn't support identity payloads or PKCS12 certificates. Required when configuring a student device for Classroom, and ignored when configuring an instructor device. Has no effect on the configuration of the Shared iPad login screen. | Default: — | Range: — |
| string | A certificate payload UUID. | Default: — | Range: — | |
Member Payload Certificate Anchor UUIDs | array | The array of UUIDs referring to certificate payloads within the same profile that the system uses to authorize group member peer certificate identities. This array must contain all certificates needed to validate the entire chain of trust. Member certificates must have the common name prefix member (case insensitive). This property doesn't support identity payloads or PKCS12 certificates. Required when configuring a student device for Classroom, and ignored when configuring an instructor device. Has no effect on the configuration of the Shared iPad login screen. | Default: — | Range: — |
| string | A certificate payload UUID. | Default: — | Range: — | |
Resource Payload Certificate UUID | string | The UUID of an identity certificate payload within the same profile that the system uses to perform client authentication when fetching additional resources, such as student images. If set, the system uses this key to configure both Classroom and the Shared iPad login screen. If not set, the system uses MDM client identity. | Default: — | Range: — |
| string | The unique string that identifies the user of this device within the organization. Don't set this value in payloads intended to configure the Shared iPad login screen. | Default: — | Range: — | |
DepartmentsarrayDepartments | array | For Shared iPad profiles: The array of dictionaries that defines which departments the system displays in the Shared iPad login screen. If set, the system uses this key to configure both Classroom and the Shared iPad login screen. | Default: — | Range: — |
DepartmentsItemdictDepartmentsDictionary | dict | A department in the organization. | Default: — | Range: — |
| string | The display name of the department. | Default: — | Range: — | |
| array | The group beacon identifiers that are members of this department. | Default: — | Range: — | |
| integer | A group beacon identifier. | Default: — | Range: — | |
DeviceGroupsarrayDevice Groups | array | For leader/teacher profiles: The array of dictionaries that defines which device groups the leader can assign devices to. Not included in member payloads. | Default: — | Range: — |
DeviceGroupsItemdictDeviceGroupsDictionary | dict | A device group in the organization. | Default: — | Range: — |
| string | The unique identifier for the device group in the organization. | Default: — | Range: — | |
| string | The name of the device group, which must be unique in the organization. | Default: — | Range: — | |
| array | The serial numbers of the devices in the group. | Default: — | Range: — | |
| string | A serial number. | Default: — | Range: — | |
Allow students to modify screen observation permissions iOS 10.3+ | boolean | If 'true', the system allows students enrolled in managed classes to modify their teacher's permissions for screen observation on their device. | Default: false | Range: — |