Skip to main content
POST
/
api
/
admin
/
user
Create a new user in the admin system. Users get 15 credits when created. When plan set to 'sdk' with a valid institution (your digital twin _id), user is automatically enrolled into the instance
curl --request POST \
  --url http://localhost:3000/api/admin/user \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "fname": "<string>",
  "lname": "<string>",
  "status": "active",
  "plan": "free",
  "accountType": "user",
  "password": "<string>",
  "institution": "<string>",
  "credits": 123,
  "picture": "<string>",
  "remember_history_count": 123,
  "mustChangePassword": true
}
'
{
  "success": true,
  "id": "<string>",
  "message": "<string>"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
email
string<email>
required
​
fname
string
required
​
lname
string
required
​
status
enum<string>
required
Available options:
active,
inactive
​
plan
enum<string>
required
Available options:
free,
sdk
​
accountType
enum<string>
required
Available options:
user,
admin
​
password
string
required
​
institution
string
required
​
credits
integer
​
picture
string<uri>
​
remember_history_count
integer
​
mustChangePassword
boolean

Response

201 - application/json

User created successfully

​
success
boolean
​
id
string
​
message
string