Get

Returns a specific guardian

2 variables
14 variables

Returns a specific guardian.

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View your Google Classroom guardians
  • View and manage guardians for students in your Google Classroom classes
  • View guardians for students in your Google Classroom classes

Input

This building block consumes 2 input parameters

  = Parameter name
  = Format

studentId STRING Required

The student whose guardian is being requested. 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 Required

The id field from a Guardian

Output

This building block provides 14 output parameters

  = Parameter name
  = Format

studentId STRING

Identifier for the student to whom the guardian relationship applies

guardianId STRING

Identifier for the guardian

invitedEmailAddress STRING

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators

guardianProfile OBJECT

Global information for a user

guardianProfile.emailAddress STRING

Email address of the user.

Read-only

guardianProfile.photoUrl STRING

URL of user's profile photo.

Read-only

guardianProfile.permissions[] OBJECT

Global user permission description

guardianProfile.permissions[].permission ENUMERATION

Permission value

guardianProfile.name OBJECT

Details of the user's name

guardianProfile.name.givenName STRING

The user's first name.

Read-only

guardianProfile.name.familyName STRING

The user's last name.

Read-only

guardianProfile.name.fullName STRING

The user's full name formed by concatenating the first and last name values.

Read-only

guardianProfile.id STRING

Identifier of the user.

Read-only

guardianProfile.verifiedTeacher BOOLEAN

Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false.

Read-only