Guardians List

Source: R/classroom_functions.R

Returns a list of guardians that the requesting user is permitted toview, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character - for the student ID.

gc_user_profiles_guardians_list(
  studentId,
  pageToken = NULL,
  invitedEmailAddress = NULL,
  pageSize = NULL
)

Arguments

studentId

Filter results by the student who the guardian is linked to
pageToken

nextPageToken
invitedEmailAddress

Filter results by the email address that the original invitation was sent
pageSize

Maximum number of items to return

Details

This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian information for that student, if '-' is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the invited_email_address filter is set by a user who is not a domain administrator, 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, nor the literal string me). May also be returned if an invalid page_token is provided.

  • NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Authentication scopes used by this function are:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly

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

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

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

See also

Google Documentation