Contents

RosterPerson

A person’s properties and their values.

Declaration

object RosterPerson

Properties

NameTypeDescription
email_addressstring

The email address of the person that Apple School Manager displays. Available in X-Protocol version 5 and later.

first_namestring

The person’s first (given) name. Maximum length iw 1024 UTF-8 characters. Available in protocol version 3 and later.

gradestring

The grade information for the student. Maximum length is 256 UTF-8 characters. Value can be null. Not used for instructors.

is_federated_authboolean

If true, the system enables federated authentication for the person from an external identity provider. Available in X-Protocol version 6 and later.

last_namestring

The person’s last name. Maximum length is 1024 UTF-8 characters. Available in protocol version 3 and later.

managed_apple_idstring

The Managed Apple Account for the person. Maximum length is 1024 UTF-8 characters.

middle_namestring

The person’s middle name. Maximum length is 1024 UTF-8 characters. Available in protocol version 3 and later.

namestring

The person’s name. Maximum length is 1024 UTF-8 characters.

op_datestring

The time stamp, in iSO 8601 format, when the system added, updated, or deleted the person.

passcode_typestring

The password policy of the person. Possible values are complex, four, or six. Available in protocol version 3 and later.

person_idstring

The personid of the person that Apple School Manager displays. Available in X-Protocol version 4 and later.

sis_usernamestring

The SIS username of the person that Apple School Manager displays. Available in X-Protocol version 5 and later.

sourcestring

The creation data source of the class.

source_system_identifierstring

The identifier that the organization configures for the person. Maximum length is 256 UTF-8 characters.

statusstring

The status of the person. Possible values are Active, InActive, FailedPasswordLocked, and AtoLocked. AtoLocked indicates that the system detects account take over and temporarily locks the person until an authentic user claims it. Available in X-Protocol version 3 and later.

unique_identifierstring

The unique identifier for the person. Maximum length 256 UTF-8 characters.

See Also

People Management