/google-classroom-people | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
google-classroom-people_accept_invitation | Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |
google-classroom-people_create_guardian_invitation | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student’s guardian. |
google-classroom-people_create_invitation | Creates an invitation. |
google-classroom-people_create_student | Adds a user as a student of a course. |
google-classroom-people_create_teacher | Creates a teacher of a course. |
google-classroom-people_delete_guardian | Deletes a guardian. |
google-classroom-people_delete_invitation | Deletes an invitation. |
google-classroom-people_delete_student | Deletes a student of a course. |
google-classroom-people_delete_teacher | Removes the specified teacher from the specified course. |
google-classroom-people_get_guardian | Returns a specific guardian. |
google-classroom-people_get_guardian_invitation | Returns a specific guardian invitation. |
google-classroom-people_get_invitation | Returns an invitation. |
google-classroom-people_get_student | Returns a student of a course. |
google-classroom-people_get_teacher | Returns a teacher of a course. |
google-classroom-people_get_user_profile | Returns a user profile. |
google-classroom-people_list_guardian_invitations | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |
google-classroom-people_list_guardians | Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. |
google-classroom-people_list_invitations | Lists invitations. At least one of userId or courseId must be specified; calls with neither will fail. |
google-classroom-people_list_students | Returns a list of students of this course that the requester is permitted to view. |
google-classroom-people_list_teachers | Returns a list of teachers of this course that the requester is permitted to view. |
google-classroom-people_patch_guardian_invitation | Modifies a guardian invitation. |
google-classroom-people_accept_invitation
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the invitation to accept. |
google-classroom-people_create_guardian_invitation
Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student’s guardian. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | ID of the student (in standard format) |
creationTime | string | No | — | The time that this invitation was created. Read-only. |
invitationId | string | No | — | Unique identifier for this invitation. Read-only. |
invitedEmailAddress | string | Yes | — | Email address that the invitation was sent to. This field is only visible to domain administrators. |
state | string | No | — | The state that this invitation is in. |
google-classroom-people_create_invitation
Creates an invitation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course to invite the user to. |
id | string | No | — | Identifier assigned by Classroom. Read-only. |
role | string | Yes | — | Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED. |
userId | string | Yes | — | 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 |
google-classroom-people_create_student
Adds a user as a student of a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. |
enrollmentCode | string | No | — | Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user. |
profile | object | No | — | Global information for a user. |
studentWorkFolder | object | No | — | Representation of a Google Drive folder. |
userId | string | No | — | Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_create_teacher
Creates a teacher of a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
profile | object | No | — | Global information for a user. |
userId | string | No | — | Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_delete_guardian
Deletes a guardian. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | The student whose guardian is to be deleted. 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 | Yes | — | The id field from a Guardian. |
google-classroom-people_delete_invitation
Deletes an invitation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the invitation to delete. |
google-classroom-people_delete_student
Deletes a student of a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
userId | string | Yes | — | Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_delete_teacher
Removes the specified teacher from the specified course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
userId | string | Yes | — | Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_get_guardian
Returns a specific guardian. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | 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 | Yes | — | The id field from a Guardian. |
google-classroom-people_get_guardian_invitation
Returns a specific guardian invitation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | The ID of the student whose guardian invitation is being requested. |
invitationId | string | Yes | — | The id field of the GuardianInvitation being requested. |
google-classroom-people_get_invitation
Returns an invitation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the invitation to return. |
google-classroom-people_get_student
Returns a student of a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
userId | string | Yes | — | Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_get_teacher
Returns a teacher of a course. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
userId | string | Yes | — | Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_get_user_profile
Returns a user profile. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
google-classroom-people_list_guardian_invitations
Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user * the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. |
invitedEmailAddress | string | No | — | If specified, only results with the specified invited_email_address are returned. |
states | string[] | No | — | If specified, only results with the specified state values are returned. Otherwise, results with a state of PENDING are returned. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
google-classroom-people_list_guardians
Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user * the string literal "-", indicating that results should be returned for all students that the requesting user has access to view. |
invitedEmailAddress | string | No | — | Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
pageSize | integer | No | — | Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
google-classroom-people_list_invitations
Lists invitations. At least one of userId or courseId must be specified; calls with neither will fail. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | No | — | Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user |
courseId | string | No | — | Restricts returned invitations to those for a course with the specified identifier. |
pageSize | integer | No | — | Maximum number of items to return. The default is 500 if unspecified or 0. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-people_list_students
Returns a list of students of this course that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
pageSize | integer | No | — | Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-people_list_teachers
Returns a list of teachers of this course that the requester is permitted to view. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
pageSize | integer | No | — | Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results. |
pageToken | string | No | — | nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. |
google-classroom-people_patch_guardian_invitation
Modifies a guardian invitation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
studentId | string | Yes | — | The ID of the student whose guardian invitation is to be modified. |
invitationId | string | Yes | — | The id field of the GuardianInvitation to be modified. |
updateMask | string | Yes | — | Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * state When set in a query parameter, this field should be specified as updateMask=,,... |
state | string | Yes | — | The state that this invitation is in. |

