Create User

Creates a User.

POST /users

Try it

Create User

cURL

curl --request POST \
  --url https://codecombat.com/api/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "role": "student",
  "preferredLanguage": "<string>",
  "heroConfig": {
    "thangType": "<string>"
  },
  "birthday": "<string>"
}
'

200

{
  "_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "role": "<string>",
  "stats": {
    "gamesCompleted": 123,
    "concepts": {},
    "playTime": 123
  },
  "oAuthIdentities": [
    {
      "provider": "<string>",
      "id": "<string>"
    }
  ],
  "subscription": {
    "ends": "<string>",
    "active": true
  },
  "license": {
    "ends": "<string>",
    "active": true
  }
}

Example

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

Authorizations

Authorization · string · header · required

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 · UsersCreateRequestHeroConfig · object

Show child attributes

heroConfig. thangType · string | null

birthday · string | null

Response

200 - application/json

The created user

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 · UserResponseStats · object

Show child attributes

stats. gamesCompleted · number<double> | null

stats. concepts · object

Show child attributes

stats.concepts. {key} · number<double>

stats. playTime · number<double> | null

Included only when specifically requested on the endpoint

oAuthIdentities · UserResponseOAuthIdentitiesItem · object[] | null

Show child attributes

oAuthIdentities. provider · string | null

oAuthIdentities. id · string | null

subscription · UserResponseSubscription · object

Show child attributes

subscription. ends · string | null

subscription. active · boolean | null

license · UserResponseLicense · object

Show child attributes

license. ends · string | null

license. active · boolean | null