Skip to main content
POST
Create User

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

Install Sid

Pattern: ^AI[a-f0-9]{32}$

Body

application/json
firstName
string
required

First Name

lastName
string
required

Last Name

email
string
required

Email

preferredEmail
string

Preferred Email

homePhone
string | null

Home Phone

mobilePhone
string | null

Mobile Phone

currencyCode
string

Currency code

timeZoneSid
string

Time Zone Sid

Pattern: ^TZ[a-f0-9]{32}$
latitude
number | null

Location Latitude

longitude
number | null

Location Longitude

username
string

Username for user

password
string

Password for user

Pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[#$@!%&*?])[A-Za-z\d#$@!%&*?]{8,30}$
enabled
boolean

If login as this user is enabled

lmsId
string | null

The id for the user as defined in the LMS as defined in the LTI launch.

sisId
string | null

The id for the user as defined in the SIS.

exernalId
string | null

The id for the user as defined in any external system for tracking.

Response

200 - application/json

Successful

sid
string | null

User SID

firstName
string | null

First name

lastName
string | null

Last name

email
string | null

Email

preferredEmail
string | null

Preferred email

username
string | null

Username

smarterIdEnrollmentSid
string | null

SmarterID enrollment SID

mobilePhone
string | null

Mobile phone

homePhone
string | null

Home phone

address
string | null

Address

lmsId
string | null

LMS ID

apiId
string | null

API ID

sisId
string | null

SIS ID

externalId
string | null

External ID

latitude
number | null

Latitude

longitude
number | null

Longitude

lastEnrollmentSync
string | null

Last enrollment sync

currencyCode
string | null

Currency code

timeZoneSid
string | null

Time zone SID

timezone
object | null

Timezone details

maxTravelDistance
number | null

Max travel distance

maxTravelDistanceUnits
string | null

Max travel distance units

createdDate
string | null

Created date

editDate
string | null

Edit date

freshdeskUserId
string | null

Freshdesk user ID

role
string | null

Role

enabled
boolean | null

Enabled

authentication
object | null

Authentication data

smarterId
object | null

SmarterID data

course
object | null

Course

exam
object | null

Exam

identity
object | null

Identity