IAccessInfo

Defined in: src/types/IAccessInfo.ts:10

An interface that defines an access information to be granted or denied. When you start a method chain with AccessControl#grant or AccessControl#deny methods, you’re actually building this object which will eventually be committed to the underlying grants model.

Properties

role?

optional role?: string | string[]

Defined in: src/types/IAccessInfo.ts:14

Indicates a single or multiple roles for this access information.

---

resource?

optional resource?: string | string[]

Defined in: src/types/IAccessInfo.ts:19

Indicates a single or multiple target resources for this access information.

---

attributes?

optional attributes?: string | string[]

Defined in: src/types/IAccessInfo.ts:26

Defines the resource attributes which are granted or denied. Omitted, it defaults to ['*']: every attribute, granted or denied. An explicit [] is kept on every authoring path: a grant of no attributes, or a deny of none.

---

action?

optional action?: string

Defined in: src/types/IAccessInfo.ts:31

Defines the type of the operation that is (or not) to be performed on the resource(s) by the defined role(s).

---

possession?

optional possession?: Possession

Defined in: src/types/IAccessInfo.ts:36

Defines the possession of the resource(s) for the specified action. for possible values.

---

condition?

optional condition?: ConditionJSON

Defined in: src/types/IAccessInfo.ts:40

Optional declarative condition attached to this grant.