Interface ParamsUsersItem

Hierarchy

  • ParamsUsersItem

Properties

address: null | string

Postal address

alternatename: null | string

The alternate name of the user

auth: string

Auth plugins include manual, ldap, etc

calendartype: string

Calendar type such as "gregorian", must exist on server

city: null | string

Home city of the user

country: null | string

Home country code of the user, such as AU or CZ

User custom fields (also known as user profil fields)

department: null | string

Department

description: null | string

User profile description, no HTML

email: string

A valid and unique email address

firstname: string

The first name(s) of the user

firstnamephonetic: null | string

The first name(s) phonetically of the user

id: null | number

ID of the user

idnumber: null | string

An arbitrary ID code number perhaps from the institution

institution: null | string

Institution

interests: null | string

User interests (separated by commas)

lang: string

Language code such as "en", must exist on server

lastname: null | string

The family name of the user

lastnamephonetic: null | string

The family name phonetically of the user

maildisplay: null | number

Email visibility

mailformat: null | number

Mail format code is 0 for plain text, 1 for HTML etc

middlename: null | string

The middle name of the user

password: string

Plain text password consisting of any characters

phone1: null | string

Phone

phone2: null | string

Mobile phone

User preferences

suspended: null | boolean

Suspend user account, either false to enable user login or true to disable it

theme: null | string

Theme name such as "standard", must exist on server

timezone: null | string

Timezone code such as Australia/Perth, or 99 for default

username: string

Username policy is defined in Moodle security config.

userpicture: null | number

The itemid where the new user picture has been uploaded to, 0 to delete

Generated using TypeDoc