Обновление educationUser
Пространство имен: microsoft.graph
Обновление свойств объекта educationUser .
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Не поддерживается. | Не поддерживается. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Для приложений | EduRoster.ReadWrite.All | Недоступно. |
HTTP-запрос
PATCH /education/me
PATCH /education/users/{id}
Заголовки запросов
Заголовок | Значение |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json |
Текст запроса
В тексте запроса укажите значения для соответствующих полей, которые необходимо обновить. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств. Для достижения оптимальной производительности не включайте существующие значения, которые не изменились.
Свойство | Тип | Описание |
---|---|---|
accountEnabled | Boolean | Если учетная запись обеспечена — значение true, в противном случае — false. Это свойство обязательно указывать при создании пользователя. Поддерживает параметр $filter. |
assignedLicenses | Коллекция assignedLicense | Лицензии, назначенные пользователю. Значение null не допускается. |
assignedPlans | Коллекция assignedPlan | Планы, назначенные пользователю. Только для чтения. Значение null не допускается. |
businessPhones | Коллекция строк | Номера телефонов пользователя. Примечание. Несмотря на то что это коллекция строк, для этого свойства можно задать только один номер. |
createdBy | identitySet | Объект, который создал пользователя. |
department | String | Название отдела, в котором работает пользователь. Поддерживает параметр $filter. |
displayName | String | Имя пользователя, отображаемое в адресной книге. Обычно это сочетание имени, отчества и фамилии пользователя. Это свойство является обязательным при создании пользователя и его невозможно очистить во время обновлений. Поддерживает параметры $filter и $orderby. |
externalSource | educationExternalSource | Источник для создания пользователя. Возможные значения: sis , manual . |
externalSourceDetail | String | Имя внешнего источника, из которого был создан этот ресурс. |
givenName; | String | Простое имя пользователя. Поддерживает параметр $filter. |
String | SMTP-адрес пользователя; например, "jeff@contoso.com". Только для чтения. Поддерживает параметр $filter. | |
mailingAddress | physicalAddress | Почтовый адрес пользователя. |
mailNickname | String | Почтовый псевдоним для пользователя. Это свойство должно быть указано при создании пользователя. Поддерживает параметр $filter. |
middleName | String | Отчество пользователя. |
mobilePhone | String | Основной сотовый телефон пользователя. |
onPremisesInfo | educationOnPremisesInfo | Дополнительные сведения, используемые для связывания пользователя AAD с его аналогом Active Directory. |
passwordPolicies | String | Задает политики паролей для пользователя. Это свойство представляет собой перечисление с возможным значением DisableStrongPassword. Оно позволяет использовать менее надежные пароли, чем предусмотрено политикой по умолчанию. Вы также можете указать значение DisablePasswordExpiration. Два значения можно указать одновременно. Пример: "DisablePasswordExpiration, DisableStrongPassword". |
passwordProfile | passwordProfile | Задает профиль пароля для пользователя. Профиль содержит пароль пользователя. Это свойство обязательно указывать при создании пользователя. Пароль в профиле должен соответствовать минимальным требованиям, указанным в свойстве passwordPolicies. По умолчанию требуется надежный пароль. |
preferredLanguage | String | Предпочитаемый язык для пользователя. Он должен быть представлен в формате ISO 639-1. Пример: "ru-RU". |
primaryRole | educationUserRole | Роль по умолчанию для пользователя. Роль пользователя для отдельного курса может отличаться. Возможные значения: student , teacher , none , unknownFutureValue . |
provisionedPlans | Коллекция provisionedPlan | Планы, подготовленные для пользователя. Только для чтения. Значение null не допускается. |
residenceAddress | physicalAddress | Адрес проживания пользователя. |
student | educationStudent | Если основная роль — учащийся, этот блок содержит данные для конкретного учащегося. |
surname | String | Фамилия пользователя. Поддерживает параметр $filter. |
teacher | educationTeacher | Если основной ролью является учитель, этот блок содержит данные для конкретного преподавателя. |
usageLocation | String | Двухбуквенный код страны (по стандарту ISO 3166). Свойство необходимо указывать для пользователей, которым будут назначены лицензии, в связи с законодательным требованием проверять доступность служб в странах или регионах. Примеры: "RU", "JP", "GB". Значение null не допускается. Поддерживает параметр $filter. |
userPrincipalName | String | Имя участника-пользователя. |
userType | String | Строковое значение, с помощью которого можно классифицировать типы пользователей в каталоге, например "Участник" и "Гость". Поддерживает параметр $filter. |
Отклик
При успешном выполнении этот метод возвратит код отклика 200 OK
и обновленный объект educationUser в теле отклика.
Пример
Запрос
Ниже показан пример запроса.
PATCH https://graph.microsoft.com/v1.0/education/users/{user-id}
Content-type: application/json
{
"displayName": "Rogelio Cazares",
"givenName": "Rogelio",
"middleName": "Fernando",
"surname": "Cazares",
}
Отклик
Ниже показан пример отклика. Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "13020",
"displayName": "Rogelio Cazares",
"givenName": "Rogelio",
"middleName": "Fernando",
"surname": "Cazares",
"mail": "rogelioC@contoso.com",
"mobilePhone": "+1 (253) 555-0101",
"createdBy": {
"user": {
"displayName": "Susana Rocha",
"id": "14012",
}
},
"externalSource": "sis",
"mailingAddress": {
"city": "Los Angeles",
"countryOrRegion": "United States",
"postalCode": "98055",
"state": "CA",
"street": "12345 Main St."
},
"primaryRole": "string",
"residenceAddress": {
"city": "Los Angeles",
"countryOrRegion": "United States",
"postalCode": "98055",
"state": "CA",
"street": "12345 Main St."
},
"student": {
"primaryRole": "student",
"externalId": "13005",
"birthDate": "2001-01-01T00:00:00Z"
}
}