string

Add Oauth2 Identity

Override where the user will navigate to after successfully logging in.

Login User

Auth

Upsert User Into Clan

Clans

Returns the classroom details for a class code.

limit the return number of members for the classroom

Get Classroom Details

Create a classroom

Upsert a user from classroom

Delete User from Classroom

Enrolls a user in a course in a classroom.
If the course is paid, user must have an active license.
User must be a member of the classroom.


limit the return number of members for the classroom, the default value is 1000

Enroll User in a Course

Removes an enrolled user from a course in a classroom.


Remove User from a classroom

Returns a list of all members stats for the classroom.


Limit the return member number. the default value is 10, and the max value is 100

Skip the members that doesn't need to return, for pagination


Get Member Stats

Returns a list of all levels played by the user for the classroom.


Get Level Session

Classrooms

Get Playtime Stats

Get License Stats

Stats

Create User

Set to non-empty string to include stats.playTime in response

Get User

Update User

limit the return number of members for each classroom

Get Classrooms By User

Get User Hero

Set the user's aceConfig (the settings for the in-game Ace code editor), such as whether to enable autocomplete.

Put Ace Config

Grants a user premium access to the "Home" version up to a certain time.


Put Subscription

If the user already has a premium access up to a certain time, this shortens/revokes his/her premium access. If the ends is less than or equal to the current time, it revokes the subscription and sets the end date to be the current time, else it just shortens the subscription.


Shorten User Subscription

Grants a user access to the "Classroom" version up to a certain time.
Sets their role to "student".


Grant User License

If the user already has access to the "Classroom" version up to a certain time, this shortens/revokes his/her access. If the ends is less than or equal to the current time, it revokes the enrollment and sets the end date to be the current time, else it just shortens the enrollment.


Shorten User License

Search for User

Users

ClanResponse

ClassroomResponse

ClassroomResponseCoursesItem

ClassroomResponseWithCode

ClassroomResponseWithCodeCoursesItem

ClassroomsCreateRequestAceConfig

ClassroomsGetMembersStatsResponseItem

ClassroomsGetMembersStatsResponseItemStats

LevelSessionResponse

For arenas. Whether or not the level has been added to the ladder.

For shareable projects. Whether or not the project has been shared with classmates.

1	curl -X PUT https://codecombat.com/api/clan/:handle/members \
2	-H "Content-Type: application/json" \
3	-u "<username>:<password>" \
4	-d '{
5	"userId": "string"
6	}'

1	{
2	"_id": "string",
3	"name": "string",
4	"displayName": "string",
5	"members": [
6	"string"
7	],
8	"ownerID": "string",
9	"description": "string",
10	"type": "string",
11	"kind": "string",
12	"metadata": {
13	"string": {}
14	}
15	}

Upsert User Into Clan

Path parameters

Request

Response