Deletes a guardian

Source: R/classroom_functions.R

The guardian will no longer receive guardian notifications and the guardianwill no longer be accessible via the API.

gc_user_profiles_guardians_delete(studentId, guardianId)

Arguments

studentId

The student whose guardian is to be deleted
guardianId

The id field from a Guardian

Details

This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors.

  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API).

  • NOT_FOUND if the requesting user is permitted to modify guardians for the requested student_id, but no Guardian record exists for that student with the provided guardian_id.

Authentication scopes used by this function are:

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

Set options(googleAuthR.scopes.selected = c("https://www.googleapis.com/auth/classroom.guardianlinks.students") Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See also

Google Documentation