Method: userProfiles.guardians.delete

Удаляет опекуна.

Опекун больше не будет получать уведомления от опекуна, и опекун больше не будет доступен через API.

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED если запрашивающему пользователю не виден ни один пользователь, соответствующий предоставленному studentId , если запрашивающему пользователю не разрешено управлять опекунами для учащегося, определенного идентификатором studentId , если опекуны не включены для рассматриваемого домена или в случае других ошибок доступа .
  • INVALID_ARGUMENT если указан studentId , но его формат не распознается (это не адрес электронной почты и не studentId из API).
  • NOT_FOUND если запрашивающему пользователю разрешено изменять опекунов для запрошенного studentId , но для этого учащегося с предоставленным guardianId не существует записи Guardian .

HTTP-запрос

DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
studentId

string

Студент, опекуна которого необходимо удалить. Одно из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
guardianId

string

Поле id из Guardian .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа пустое.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Дополнительную информацию см. в руководстве по авторизации .