Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.students.delete
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.
HTTP request
DELETE https://classroom.googleapis.com/v1/courses/{courseId}/students/{userId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
|
userId |
string
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
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.rosters
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-05 UTC.
[null,null,["Last updated 2024-12-05 UTC."],[[["Deletes a specified student from a given course using their ID."],["Requires authorization with the `https://www.googleapis.com/auth/classroom.rosters` scope."],["Returns an error if the user lacks permission, the student or course is not found, or there are access issues."],["Uses a DELETE request to the endpoint `https://classroom.googleapis.com/v1/courses/{courseId}/students/{userId}` with course and student IDs as path parameters."],["The request body should be empty, and a successful deletion results in an empty response body."]]],[]]
