Create User

Creates a User.

Example

url = 'https://codecombat.com/api/users'
json = { email: '[e-mail]', name: 'Some Username', role: 'student' }
request.post({ url, json, auth })

Authorizations

Authorization

string

headerrequired

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

Body

application/json

name

string

required

email

string

required

role

enum<string> | null

"student" or "teacher". If unset, a home user will be created, unable to join classrooms.

Available options:

student,

teacher

preferredLanguage

string | null

heroConfig

object | null

Show child attributes

heroConfig.thangType

string | null

birthday

string | null

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