GOgoogle
userProfiles

GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

Changed on

Returns a specific guardian invitation. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations 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 Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
  • Auth
    • 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 ID of the student whose guardian invitation is being requested.

invitationIdstring required

The id field of the GuardianInvitation being requested.

Response

Successful response

creationTimestring google-datetime

The time that this invitation was created. Read-only.

invitationIdstring

Unique identifier for this invitation. Read-only.

invitedEmailAddressstring

Email address that the invitation was sent to. This field is only visible to domain administrators.

state'GUARDIAN_INVITATION_STATE_UNSPECIFIED' | 'PENDING' | 'COMPLETE'

The state that this invitation is in.

studentIdstring

ID of the student (in standard format)

Changes

  • d9e82ce809f1Revision changes
    • info

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

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students 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.students was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.guardianlinks.students 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