Grant User License

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

url = `https://codecombat.com/api/users/${userID}/license`
json = { ends: new Date('2017-01-01').toISOString() }
request.put({ url, json, auth }, (err, res) => {
  console.log(res.body.license) // { ends: '2017-01-01T00:00:00.000Z', active: true }
})

Authorizations

Authorization

string

headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

handle

string

required

The document's _id or slug.

Body

application/json

ends

string

required

Response

200 - application/json

Subset of properties listed here

_id

string | null

email

string | null

name

string | null

slug

string | null

role

string | null

Usually either 'teacher' or 'student'

stats

object | null

Show child attributes

stats.gamesCompleted

number | null

stats.concepts

object | null

Show child attributes

stats.concepts.{key}

number

stats.playTime

number | null

Included only when specifically requested on the endpoint

oAuthIdentities

object[] | null

Show child attributes

oAuthIdentities.provider

string | null

oAuthIdentities.id

string | null

subscription

object | null

Show child attributes

subscription.ends

string | null

subscription.active

boolean | null

license

object | null

Show child attributes

license.ends

string | null

license.active

boolean | null