Get

Returns an invitation

1 variables
4 variables

Returns an invitation.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view the requested invitation or for access errors.
  • NOT_FOUND if no invitation exists with the requested ID

Authorization

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

  • Manage your Google Classroom class rosters
  • View your Google Classroom class rosters

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

id STRING Required

Identifier of the invitation to return

Output

This building block provides 4 output parameters

  = Parameter name
  = Format

courseId STRING

Identifier of the course to invite the user to

id STRING

Identifier assigned by Classroom.

Read-only

role ENUMERATION

Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED

userId STRING

Identifier of the invited user.

When specified as a parameter of a request, this identifier can be set to one of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user