Тип ресурса educationUser
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет пользователя в системе. Этот ресурс является зависящим от образования вариантом ресурса стандартного пользователя с тем же id , что Microsoft Graph возвращает из конечной точки, не относяющейся к /users образованию.
Этот объект предоставляет целевое подмножество свойств из основного объекта пользователя и добавляет набор свойств, относящихся к образованию, таких как primaryRole, studentи teacher.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Получение пользователя | educationUser | Считывание свойств и связей объекта educationUser. |
| Перечисление курсов | Коллекция educationClass | Получение коллекции объектов educationClass, для которых пользователь является участником. |
| Перечисление учебных заведений | Коллекция educationSchool | Получение коллекции объектов educationSchool, для которых пользователь является участником. |
| Получение пользователя | user | Получение простого каталога user, который соответствует этому объекту educationUser. |
| Обновление | educationUser | Обновление объекта educationUser. |
| Удаление пользователя | Нет | Удаление объекта educationUser. |
| Получение дельты | Коллекция educationUser | Получение добавочных изменений для educationUsers. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| id | String | Уникальный идентификатор пользователя. Наследуется от directoryObject. Ключ. Значение null не допускается. Только для чтения. |
| accountEnabled | Boolean | Если учетная запись обеспечена — значение true, в противном случае — false. Это свойство обязательно указывать при создании пользователя. Поддерживает параметр $filter. |
| assignedLicenses | Коллекция assignedLicense | Лицензии, назначенные пользователю. Значение null не допускается. |
| assignedPlans | Коллекция assignedPlan | Планы, назначенные пользователю. Только для чтения. Значение null не допускается. |
| businessPhones | Коллекция строк | Номера телефонов пользователя. Примечание. Несмотря на то что это коллекция строк, для этого свойства можно задать только один номер. |
| createdBy | identitySet | Объект, который создал пользователя. |
| department | String | Название отдела, в котором работает пользователь. Поддерживает параметр $filter. |
| displayName | String | Имя пользователя, отображаемое в адресной книге. Поддерживает параметры $filter и $orderby. |
| externalSource | String | Тип внешнего источника, из который был создан этот ресурс (автоматически определяется из externalSourceDetail). Возможные значения: sis, lms или manual. |
| externalSourceDetail | String | Имя внешнего источника, из который был создан этот ресурс. |
| givenName; | String | Простое имя пользователя. Поддерживает параметр $filter. |
| String | SMTP-адрес пользователя; например, "jeff@contoso.com". Только для чтения. Поддерживает параметр $filter. | |
| mailNickname | String | Почтовый псевдоним для пользователя. Это свойство должно быть указано при создании пользователя. Поддерживает параметр $filter. |
| mailingAddress | physicalAddress | Почтовый адрес пользователя. Примечание. type И postOfficeBox не поддерживаются для educationUser ресурсов. |
| middleName | String | Отчество пользователя. |
| mobilePhone | String | Основной сотовый телефон пользователя. |
| officeLocation | String | Расположение офиса пользователя. |
| onPremisesInfo | educationOnPremisesInfo | Дополнительные сведения, используемые для связывания пользователя Microsoft Entra с его аналогом Active Directory. |
| passwordPolicies | String | Задает политики паролей для пользователя. Дополнительные сведения см. в разделе Стандартный ресурс пользователя . |
| passwordProfile | passwordProfile | Задает профиль пароля для пользователя. Профиль содержит пароль пользователя. Это свойство обязательно указывать при создании пользователя. Дополнительные сведения см. в разделе Стандартный ресурс пользователя . |
| preferredLanguage | String | Предпочитаемый язык для пользователя. Он должен быть представлен в формате ISO 639-1. Пример: "ru-RU". |
| primaryRole | string | Роль по умолчанию для пользователя. Роль пользователя для отдельного курса может отличаться. Возможные значения: student, teacher, faculty. Поддерживает параметр $filter. |
| provisionedPlans | Коллекция provisionedPlan | Планы, подготовленные для пользователя. Только для чтения. Значение null не допускается. |
| relatedContacts | коллекция relatedContact | Связанные записи, связанные с пользователем. Возможные связи: parent, relative, aide, doctor, guardian, child, , other. unknownFutureValue |
| residenceAddress | physicalAddress | Адрес проживания пользователя. Примечание. type И postOfficeBox не поддерживаются для educationUser ресурсов. |
| student | educationStudent | Если основная роль — учащийся, этот блок содержит данные для конкретного учащегося. |
| surname | String | Фамилия пользователя. Поддерживает параметр $filter. |
| teacher | educationTeacher | Если основной ролью является учитель, этот блок содержит данные для конкретного преподавателя. |
| usageLocation | String | Двухбуквенный код страны (ISO 3166 Alpha-2). Требуется для пользователей, которым назначены лицензии. Значение null не допускается. Поддерживает параметр $filter. |
| userPrincipalName | String | Имя участника-пользователя (UPN) для пользователя. Поддерживает параметры $filter и $orderby. Дополнительные сведения см. в разделе Стандартный ресурс пользователя . |
| userType | String | Строковое значение, с помощью которого можно классифицировать типы пользователей в каталоге, например "Участник" и "Гость". Поддерживает параметр $filter. |
Важно!
При использовании областей делегированных разрешений Graph возвращает только ограниченный набор свойств: id, primaryRole, accountEnabled, displayNamegivenName, , surname, userPrincipalName, userTypeonPremisesInfo, , student/externalId. teacher/externalId Если приложению требуются дополнительные свойства, необходимо использовать области разрешений приложения.
Связи
| Связь | Тип | Описание |
|---|---|---|
| assignments | educationAssignment | Список назначений для пользователя. Допускается значение null. |
| classes | Коллекция educationClass | Курсы пользователя. Допускается значение NULL. |
| schools | Коллекция educationSchool | Учебные заведения пользователя. Допускается значение null. |
| классы taughtClasses | Коллекция educationClass | Классы, для которых пользователь является преподавателем. |
| Рубрики | коллекция educationRubric | Если задано значение , то к заданию прилагается рубрика оценки. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"accountEnabled": true,
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"assignedPlans": [{ "@odata.type": "microsoft.graph.assignedPlan" }],
"businessPhones": ["String"],
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"department": "String",
"displayName": "String",
"externalSource": "string",
"givenName": "String",
"id": "String (identifier)",
"mail": "String",
"mailNickname": "String",
"mailingAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"middleName": "String",
"mobilePhone": "String",
"officeLocation": "String",
"onPremisesInfo": {
"@odata.type": "microsoft.graph.educationOnPremisesInfo"
},
"passwordPolicies": "String",
"passwordProfile": { "@odata.type": "microsoft.graph.passwordProfile" },
"preferredLanguage": "String",
"primaryRole": "string",
"provisionedPlans": [{ "@odata.type": "microsoft.graph.provisionedPlan" }],
"residenceAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"student": { "@odata.type": "microsoft.graph.educationStudent" },
"surname": "String",
"teacher": { "@odata.type": "microsoft.graph.educationTeacher" },
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String"
}