Method: userProfiles.guardians.delete

刪除監護人。

監護人將不再收到監護人通知，也無法透過 API 存取監護人。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED 如果要求使用者無法看到與提供的 studentId 相符的使用者、如果要求使用者無法管理 studentId 所識別學生的監護人、如果該網域未啟用監護人功能，或是其他存取錯誤。
  • INVALID_ARGUMENT：如果指定了 studentId，但系統無法辨識其格式 (不是電子郵件地址，也不是 API 中的 studentId)。
  • NOT_FOUND：如果要求使用者有權修改所要求 studentId 的監護人，但該學生沒有使用提供的 guardianId 的 Guardian 記錄。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
studentId

string

要刪除監護人的學生。可以是下列其中一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示要求使用者
guardianId

string

Guardian 中的 id 欄位。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會留白。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。