Method: userProfiles.guardians.delete

Deletes a guardian.

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

This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided studentId is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the studentId, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a studentId is specified, but its format cannot be recognized (it is not an email address, nor a studentId from the API).
  • NOT_FOUND if the requesting user is permitted to modify guardians for the requested studentId, but no Guardian record exists for that student with the provided guardianId.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
studentId

string

The student whose guardian is to be deleted. One of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user

guardianId

string

The id field from a Guardian.

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Auth Guide.

Try it!

发送以下问题的反馈:

此网页
Classroom API
Classroom API
需要帮助?请访问我们的支持页面