bpmn-server / SecureUser

Class: SecureUser

Implements

• ISecureUser

Table of contents

Constructors

• constructor

Properties

• userName
• userGroups
• tenantId
• modelsOwner

Methods

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

Constructors

constructor

• new SecureUser(params): SecureUser

Parameters

Name	Type
params	IUserInfo

Returns

SecureUser

Defined in

API/SecureUser.ts:40

Properties

userName

• userName: any

Implementation of

ISecureUser.userName

Defined in

API/SecureUser.ts:36

---

userGroups

• userGroups: any

Implementation of

ISecureUser.userGroups

Defined in

API/SecureUser.ts:37

---

tenantId

• Optional tenantId: any

Implementation of

ISecureUser.tenantId

Defined in

API/SecureUser.ts:38

---

modelsOwner

• Optional modelsOwner: any

Implementation of

ISecureUser.modelsOwner

Defined in

API/SecureUser.ts:39

Methods

SystemUser

▸ SystemUser(): SecureUser

Returns

SecureUser

Defined in

API/SecureUser.ts:53

---

isAdmin

▸ isAdmin(): boolean

Returns

boolean

Implementation of

ISecureUser.isAdmin

Defined in

API/SecureUser.ts:56

---

isSystem

▸ isSystem(): boolean

Returns

boolean

Implementation of

ISecureUser.isSystem

Defined in

API/SecureUser.ts:61

---

inGroup

▸ inGroup(userGroup): boolean

Parameters

Name	Type
userGroup	any

Returns

boolean

Implementation of

ISecureUser.inGroup

Defined in

API/SecureUser.ts:66

---

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

API/SecureUser.ts:76

---

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

API/SecureUser.ts:115

---

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

API/SecureUser.ts:127

---

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

API/SecureUser.ts:149

---

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

API/SecureUser.ts:160

---

canModifyModel

▸ canModifyModel(name): boolean

Parameters

Name	Type
name	any

Returns

boolean

Implementation of

ISecureUser.canModifyModel

Defined in

API/SecureUser.ts:170

---

canDeleteModel

▸ canDeleteModel(name): boolean

Parameters

Name	Type
name	any

Returns

boolean

Implementation of

ISecureUser.canDeleteModel

Defined in

API/SecureUser.ts:178

---

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

API/SecureUser.ts:189

---

canInvoke

▸ canInvoke(item): boolean

Parameters

Name	Type
item	any

Returns

boolean

Implementation of

ISecureUser.canInvoke

Defined in

API/SecureUser.ts:192

---

canAssign

▸ canAssign(item): boolean

Parameters

Name	Type
item	any

Returns

boolean

Implementation of

ISecureUser.canAssign

Defined in

API/SecureUser.ts:201

---

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

API/SecureUser.ts:228