@serenity-is/corelib / UserDefinition

Interface: UserDefinition

Table of contents

Properties

• DisplayName
• IsAdmin
• Permissions
• Username

Properties

DisplayName

• Optional DisplayName: string

Display name of the logged user

Defined in

src/q/userdefinition.ts:9

---

IsAdmin

• Optional IsAdmin: boolean

This indicates that the user is a super "admin", e.g. assumed to have all the permissions available. It does not mean a member of Administrators, who might not have some of the permissions

Defined in

src/q/userdefinition.ts:13

---

Permissions

• Optional Permissions: Object

A hashset of permission keys that the current user have, explicitly assigned or via its roles. Note that client side permission checks should only be used for UI enable/disable etc. You should not rely on client side permission checks and always re-check permissions server side.

Index signature

▪ [key: string]: boolean

Defined in

src/q/userdefinition.ts:19

---

Username

• Optional Username: string

Username of the logged user

Defined in

src/q/userdefinition.ts:5