GOgoogle
courses

POST /v1/courses/{courseId}/students

Changed on

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.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/courses/{courseId}/students
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.profile.emails
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.profile.emails
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.profile.photos
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.profile.photos
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.rosters
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.rosters

Path parameters

courseIdstring required

Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

Query parameters

enrollmentCodestring

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.

Request body

courseIdstring

Identifier of the course. Read-only.

userIdstring

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

Response

Successful response

courseIdstring

Identifier of the course. Read-only.

userIdstring

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

Changes

  • d9e82ce809f1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.profile.emails was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.profile.emails was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.rosters was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.rosters was removed from the endpoint's security scheme Oauth2c

  • 8575901d0ec9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.profile.emails was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.profile.emails was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.rosters was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.rosters was removed from the endpoint's security scheme Oauth2c