GOgoogle
userProfiles

GET /v1/userProfiles/{studentId}/guardians/{guardianId}

Changed on

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.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.guardianlinks.students
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.guardianlinks.students
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly

Path parameters

studentIdstring 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

guardianIdstring required

The id field from a Guardian.

Response

Successful response

guardianIdstring

Identifier for the guardian.

invitedEmailAddressstring

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

studentIdstring

Identifier for the student to whom the guardian relationship applies.

Changes

  • d9e82ce809f1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly was removed from the endpoint's security scheme Oauth2c

  • 8575901d0ec9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly was removed from the endpoint's security scheme Oauth2c