bpmn-server / SecureUser

Class: SecureUser

Implements

• ISecureUser

Table of contents

Constructors

• constructor

Properties

• userName
• userGroups
• tenantId
• modelsOwner
• #bypass
• warned

Accessors

• securityBypassed

Methods

• SystemUser
• isAdmin
• isSystem
• inGroup
• qualifyInstances
• qualifyItems
• qualifyStartEvents
• qualifyDeleteInstances
• qualifyModels
• canModifyModel
• canDeleteModel
• qualifyViewItems
• canInvoke
• canAssign
• canStart

Constructors

constructor

• new SecureUser(params, options?): SecureUser

Parameters

Name	Type	Description
params	IUserInfo	-
options	Object	-
options.enforceSecurity?	boolean	true or false decides it for this user; absent, the environment does (as before, but for this user only: the upstream set it once for the whole process, and never back)

Returns

SecureUser

Defined in

packages/bpmn-server/src/API/SecureUser.ts:52

Properties

userName

• userName: any

Implementation of

ISecureUser.userName

Defined in

packages/bpmn-server/src/API/SecureUser.ts:39

---

userGroups

• userGroups: any

Implementation of

ISecureUser.userGroups

Defined in

packages/bpmn-server/src/API/SecureUser.ts:40

---

tenantId

• Optional tenantId: any

Implementation of

ISecureUser.tenantId

Defined in

packages/bpmn-server/src/API/SecureUser.ts:41

---

modelsOwner

• Optional modelsOwner: any

Implementation of

ISecureUser.modelsOwner

Defined in

packages/bpmn-server/src/API/SecureUser.ts:42

---

#bypass

• Private Readonly #bypass: boolean

Whether the security rules are off for this user: decided when it is made, never changed after, never shared with another user.

Defined in

packages/bpmn-server/src/API/SecureUser.ts:44

---

warned

▪ Static Private warned: boolean = false

Defined in

packages/bpmn-server/src/API/SecureUser.ts:45

Accessors

securityBypassed

• get securityBypassed(): boolean

Whether this user's security rules are off.

Returns

boolean

Defined in

packages/bpmn-server/src/API/SecureUser.ts:61

Methods

SystemUser

▸ SystemUser(): SecureUser

Returns

SecureUser

Defined in

packages/bpmn-server/src/API/SecureUser.ts:62

---

isAdmin

▸ isAdmin(): boolean

Returns

boolean

Implementation of

ISecureUser.isAdmin

Defined in

packages/bpmn-server/src/API/SecureUser.ts:65

---

isSystem

▸ isSystem(): boolean

Returns

boolean

Implementation of

ISecureUser.isSystem

Defined in

packages/bpmn-server/src/API/SecureUser.ts:70

---

inGroup

▸ inGroup(userGroup): boolean

Parameters

Name	Type
userGroup	any

Returns

boolean

Implementation of

ISecureUser.inGroup

Defined in

packages/bpmn-server/src/API/SecureUser.ts:75

---

qualifyInstances

▸ qualifyInstances(query): any

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

any

query

Implementation of

ISecureUser.qualifyInstances

Defined in

packages/bpmn-server/src/API/SecureUser.ts:85

---

qualifyItems

▸ qualifyItems(query): any

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

any

query

Implementation of

ISecureUser.qualifyItems

Defined in

packages/bpmn-server/src/API/SecureUser.ts:124

---

qualifyStartEvents

▸ qualifyStartEvents(query): any

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

any

query

Implementation of

ISecureUser.qualifyStartEvents

Defined in

packages/bpmn-server/src/API/SecureUser.ts:136

---

qualifyDeleteInstances

▸ qualifyDeleteInstances(query): any

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

any

query

Implementation of

ISecureUser.qualifyDeleteInstances

Defined in

packages/bpmn-server/src/API/SecureUser.ts:158

---

qualifyModels

▸ qualifyModels(query): any

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

any

query

Implementation of

ISecureUser.qualifyModels

Defined in

packages/bpmn-server/src/API/SecureUser.ts:169

---

canModifyModel

▸ canModifyModel(name): boolean

Parameters

Name	Type
name	any

Returns

boolean

Implementation of

ISecureUser.canModifyModel

Defined in

packages/bpmn-server/src/API/SecureUser.ts:179

---

canDeleteModel

▸ canDeleteModel(name): boolean

Parameters

Name	Type
name	any

Returns

boolean

Implementation of

ISecureUser.canDeleteModel

Defined in

packages/bpmn-server/src/API/SecureUser.ts:187

---

qualifyViewItems

▸ qualifyViewItems(query): Promise\<void>

alters the query adding conditions based on security rules

Parameters

Name	Type
query	any

Returns

Promise\<void>

query

Implementation of

ISecureUser.qualifyViewItems

Defined in

packages/bpmn-server/src/API/SecureUser.ts:198

---

canInvoke

▸ canInvoke(item): boolean

Parameters

Name	Type
item	any

Returns

boolean

Implementation of

ISecureUser.canInvoke

Defined in

packages/bpmn-server/src/API/SecureUser.ts:201

---

canAssign

▸ canAssign(item): boolean

Parameters

Name	Type
item	any

Returns

boolean

Implementation of

ISecureUser.canAssign

Defined in

packages/bpmn-server/src/API/SecureUser.ts:210

---

canStart

▸ canStart(name, startNodeId, user): Promise\<void>

Parameters

Name	Type
name	any
startNodeId	any
user	any

Returns

Promise\<void>

Implementation of

ISecureUser.canStart

Defined in

packages/bpmn-server/src/API/SecureUser.ts:237

Comments