students

Overview

Name	students
Type	Resource
Id	googleworkspace.classroom.students

Fields

Name	Datatype	Description
studentWorkFolder	object	Representation of a Google Drive folder.
userId	string	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
courseId	string	Identifier of the course. Read-only.
profile	object	Global information for a user.

Methods

Name	Accessible by	Required Params	Description
courses_students_get	SELECT	courseId, userId	Returns a student of a course. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to view students of this course or for access errors. NOT_FOUND if no student of this course has the requested ID or if the course does not exist.
courses_students_list	SELECT	courseId	Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: NOT_FOUND if the course does not exist. PERMISSION_DENIED for access errors.
courses_students_create	INSERT	courseId	Adds a user as a student of a course. Domain administrators are permitted to directly add users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to create students in this course or for access errors. NOT_FOUND if the requested course ID does not exist. FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors: CourseMemberLimitReached CourseNotModifiable UserGroupsMembershipLimitReached InactiveCourseOwner ALREADY_EXISTS if the user is already a student or teacher in the course.
courses_students_delete	DELETE	courseId, userId	Deletes a student of a course. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to delete students of this course or for access errors. NOT_FOUND if no student of this course has the requested ID or if the course does not exist.