- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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.
HTTP request
POST https://classroom.googleapis.com/v1/courses/{courseId}/students
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
courseId |
Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an |
Query parameters
Parameters | |
---|---|
enrollmentCode |
Enrollment code of the course to create the student in. This code is required if |
Request body
The request body contains an instance of Student
.
Response body
If successful, the response body contains a newly created instance of Student
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.profile.emails
https://www.googleapis.com/auth/classroom.profile.photos
For more information, see the Authorization guide.