Returns a specific guardian.
This method returns the following error codes:
PERMISSION_DENIED
if no user that matches the providedstudentId
is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by thestudentId
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudentId
is specified, but its format cannot be recognized (it is not an email address, nor astudentId
from the API, nor the literal stringme
).NOT_FOUND
if the requesting user is permitted to view guardians for the requestedstudentId
, but noGuardian
record exists for that student that matches the providedguardianId
.
HTTP request
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
studentId |
The student whose guardian is being requested. One of the following:
|
guardianId |
The |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Guardian
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
For more information, see the Authorization guide.