Skip to content

Properties

idstring
required·

The unique identifier for the user

created_atstring · date-time

The date and time the user record was created

custom_fieldsobject

Provider or customer specific fields mapped into a flexible key-value object

emailsobject[]

The emails of the user

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

first_namestring

The user's first name

job_titlestring

The user's job title, when available

last_namestring

The user's last name

localestring

The locale of the user, when available. Example: en-US

managerobject

The user's manager, when available

emailsobject[]

The emails of the user

3 properties
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

idstring

The unique identifier for a user

namestring

The name of the user

namestring

The user's name

organizationobject

The organization or tenant the user belongs to, when available

idstring

The unique identifier for an organization

namestring

The name of the organization

phonesobject[]

The phones of the user

extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

rolestring

The primary role of the user in the LMS

Possible values:
learnerinstructoradminmanagerother
statusstring

The lifecycle status of the user in the LMS

Possible values:
activeinactiveinvitedsuspendeddeletedunknown
timezonestring

The timezone of the user, when available. Example: Asia/Kolkata

updated_atstring · date-time

The date and time the user record was last updated

usernamestring

The user's username or login identifier, when different from email