Class PlaceUser

Representation of the user model in Place

Hierarchy (View Summary)

Constructors

constructor

Properties

authority_id building card_number confirm_password country created_at department email email_digest first_name groups id image last_name locatable login_name metadata misc name nickname password phone photo_upload_id preferred_language staff_id support sys_admin ui_theme updated_at version work_overrides work_preferences

Methods

toJSON

Constructors

constructor

Properties

Readonlyauthority_id

authority_id: string

ID of the authority associated with the user

Readonlybuilding

building: string

Office building the user is associated

Readonlycard_number

card_number: string

Card Number associated with the user

Protectedconfirm_password

confirm_password: string = ''

Password

Readonlycountry

country: string

Country that the user resides in

Readonlycreated_at

created_at: number

Unix epoch in seconds of the creation time of the object

Readonlydepartment

department: string

Organisational department the user belongs

Readonlyemail

email: string

Email address of the user

Readonlyemail_digest

email_digest: string

Hash of the email address of the user

Readonlyfirst_name

first_name: string

First name of the user

Readonlygroups

groups: string[]

Access control groups that user is associated

Readonlyid

id: string

Unique Identifier of the object

Readonlyimage

image: string

Avatar image for the user

Readonlylast_name

last_name: string

Last name of the user

Readonlylocatable

locatable: boolean

Whether the user has opted in to location tracking

Readonlylogin_name

login_name: string

Username credential of the user

Readonlymetadata

metadata: string

Additional metadata associated with the user

Readonlymisc

misc: string

Miscellaneous user data

Readonlyname

name: string

Human readable name of the object

Readonlynickname

nickname: string

Display nickname of the user

Protectedpassword

password: string = ''

Password

Readonlyphone

phone: string

Phone number of the user

Readonlyphoto_upload_id

photo_upload_id: string

ID of the user's photo in the PlaceOS uploads service

Readonlypreferred_language

preferred_language: string

Preferred language of the user

Readonlystaff_id

staff_id: string

Organisation ID of the user

Readonlysupport

support: boolean

Whether user is a support role

Readonlysys_admin

sys_admin: boolean

Whether user is a system admin role

Readonlyui_theme

ui_theme: string

Name of the active theme on the displayed UI

Readonlyupdated_at

updated_at: number

Unix epoch in seconds of the creation time of the object

Readonlyversion

version: number

Version of the data

Readonlywork_overrides

work_overrides: Record<string, WorktimePreference>

Overrides of the worktime preferences for the user

Readonlywork_preferences

work_preferences: WorktimePreference[]

Default worktime preferences for the user

Methods

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Methods