User

@icure/medical-device-sdk / User

Class: User

Table of contents

Constructors

• constructor

Properties

• authenticationTokens
• created
• deletionDate
• deviceId
• email
• groupId
• healthcarePartyId
• id
• login
• mobilePhone
• name
• passwordHash
• patientId
• properties
• rev
• roles
• secret
• sharingDataWith
• use2fa

Methods

• marshal

Constructors

constructor

• new User(json)

Parameters

Name	Type
json	IUser

Defined in

src/models/User.ts:18

Properties

authenticationTokens

• authenticationTokens: Object

Encrypted and time-limited Authentication tokens used for inter-applications authentication

Index signature

▪ [key: string]: AuthenticationToken

Defined in

src/models/User.ts:102

---

created

• Optional created: number

the creation date of the user (encoded as epoch).

Defined in

src/models/User.ts:42

---

deletionDate

• Optional deletionDate: number

the soft delete timestamp. When a user is ”deleted“, this is set to a non null value: the moment of the deletion

Defined in

src/models/User.ts:38

---

deviceId

• Optional deviceId: string

Id of the patient if the user is a patient

Defined in

src/models/User.ts:86

---

email

• Optional email: string

email address of the user (used for token exchange or password recovery).

Defined in

src/models/User.ts:94

---

groupId

• Optional groupId: string

id of the group (practice/hospital) the user is member of

Defined in

src/models/User.ts:74

---

healthcarePartyId

• Optional healthcarePartyId: string

Id of the healthcare party if the user is a healthcare party.

Defined in

src/models/User.ts:78

---

id

• Optional id: string

the Id of the user. We encourage using either a v4 UUID or a HL7 Id.

Defined in

src/models/User.ts:30

---

login

• Optional login: string

Username for this user. We encourage using an email address

Defined in

src/models/User.ts:58

---

mobilePhone

• Optional mobilePhone: string

mobile phone of the user (used for token exchange or password recovery).

Defined in

src/models/User.ts:98

---

name

• Optional name: string

Last name of the user. This is the official last name that should be used for official administrative purposes.

Defined in

src/models/User.ts:46

---

passwordHash

• Optional passwordHash: string

Hashed version of the password (BCrypt is used for hashing)

Defined in

src/models/User.ts:62

---

patientId

• Optional patientId: string

Id of the patient if the user is a patient

Defined in

src/models/User.ts:82

---

properties

• properties: Set<Property>

Extra properties for the user. Those properties are typed (see class Property)

Defined in

src/models/User.ts:50

---

rev

• Optional rev: string

the revision of the user in the database, used for conflict management / optimistic locking.

Defined in

src/models/User.ts:34

---

roles

• roles: Set<string>

Roles assigned to this user

Defined in

src/models/User.ts:54

---

secret

• Optional secret: string

Secret token used to verify 2fa

Defined in

src/models/User.ts:66

---

sharingDataWith

• sharingDataWith: Object

Ids of the dataOwners with who the user is sharing all new data he is creating in iCure : All Data Types that may be shared can be found in SharedDataType enum

Type declaration

Name	Type
administrativeData	undefined | Set<string>
all	undefined | Set<string>
confidentialInformation	undefined | Set<string>
financialInformation	undefined | Set<string>
generalInformation	undefined | Set<string>
medicalInformation	undefined | Set<string>
sensitiveInformation	undefined | Set<string>

Defined in

src/models/User.ts:90

---

use2fa

• Optional use2fa: boolean

Whether the user has activated two factors authentication

Defined in

src/models/User.ts:70

Methods

marshal

▸ marshal(): IUser

Returns

IUser

Defined in

src/models/User.ts:104