Method: userProfiles.guardians.delete

删除监护人。

监护人将不再收到监护人通知，并且无法再通过 API 访问监护人。

此方法会返回以下错误代码：

  • 如果请求用户无法看到与所提供的 studentId 匹配的任何用户，如果请求用户不被允许管理 studentId 所标识的学生的监护人，如果未为相关网域启用监护人，或者存在其他访问权限错误，则返回 PERMISSION_DENIED。
  • 如果指定了 studentId，但无法识别其格式（既不是电子邮件地址，也不是 API 中的 studentId），则为 INVALID_ARGUMENT。
  • 如果请求的用户被允许修改所请求的 studentId 的监护人，但不存在具有所提供 guardianId 的学生的 Guardian 记录，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

要删除监护人的学生。以下项之一：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示请求用户
guardianId

string

Guardian 中的 id 字段。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文为空的 JSON 对象。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅授权指南。