Returns a specific guardian.
gc_user_profiles_guardians_get(studentId, guardianId)
studentId | The student whose guardian is being requested |
---|---|
guardianId | The |
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 view guardian information 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, nor the literal string me
).
NOT_FOUND
if the requesting user is permitted to view guardians for the requested student_id
, but no Guardian
record exists for that student that matches the provided guardian_id
.
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.