Sign in

v2

OpenAPI 3.0.02026-07-2163203194.5 KB
User

Create User

Creates a new user for the specified install.

post/v1/installs/{installSid}/users

Path parameters

installSidstring required

Install Sid

Install Sid

Request body

firstNamestring required

First Name

lastNamestring required

Last Name

emailstring required

Email

preferredEmailstring

Preferred Email

homePhonestring nullable

Home Phone

mobilePhonestring nullable

Mobile Phone

currencyCodestring

Currency code

timeZoneSidstring

Time Zone Sid

latitudenumber nullable

Location Latitude

longitudenumber nullable

Location Longitude

usernamestring

Username for user

passwordstring

Password for user

enabledboolean

If login as this user is enabled

lmsIdstring nullable

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

sisIdstring nullable

The id for the user as defined in the SIS.

exernalIdstring nullable

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

Response

Successful

sidstring nullable

User SID

firstNamestring nullable

First name

lastNamestring nullable

Last name

emailstring nullable

Email

preferredEmailstring nullable

Preferred email

usernamestring nullable

Username

smarterIdEnrollmentSidstring nullable

SmarterID enrollment SID

mobilePhonestring nullable

Mobile phone

homePhonestring nullable

Home phone

addressstring nullable

Address

lmsIdstring nullable

LMS ID

apiIdstring nullable

API ID

sisIdstring nullable

SIS ID

externalIdstring nullable

External ID

latitudenumber nullable

Latitude

longitudenumber nullable

Longitude

lastEnrollmentSyncstring nullable

Last enrollment sync

currencyCodestring nullable

Currency code

timeZoneSidstring nullable

Time zone SID

timezoneTimezone nullable

Timezone details

maxTravelDistancenumber nullable

Max travel distance

maxTravelDistanceUnitsstring nullable

Max travel distance units

createdDatestring nullable

Created date

editDatestring nullable

Edit date

freshdeskUserIdstring nullable

Freshdesk user ID

rolestring nullable

Role

enabledboolean nullable

Enabled

authenticationAuthentication nullable

Authentication data

smarterIdSmarterId nullable

SmarterID data

courseModel28 nullable

Course

examModel29 nullable

Exam

identityIdentity nullable

Identity