Class RolesManager

Roles Manager service provides checking access actions against configured roles and their policies.

Hierarchy

RolesManager

Implements

EarlyInitializedServiceInterface

Index

Constructors

Properties

_baseDirectory _loadPromise? _policyManager _roles? _validator

Methods

checkPolicy getActionConditionsForRole getPolicyActionConditions load loadRoles validateActionForRole

Constructors

constructor

new RolesManager(_baseDirectory: string, _policyManager: PolicyManager, _validator: Validator): RolesManager
Parameters
- _baseDirectory: string
- _policyManager: PolicyManager
- _validator: Validator
Returns RolesManager
- Defined in src/policies/RolesManager.ts:31

Properties

`Protected` `Readonly` _baseDirectory

_baseDirectory: string

`Protected` `Optional` _loadPromise

_loadPromise?: Promise<void>

`Protected` `Readonly` _policyManager

_policyManager: PolicyManager

`Protected` `Optional` _roles

_roles?: {
[key: string]: Policy[];
}

Type declaration

[key: string]: Policy[]

`Protected` `Readonly` _validator

_validator: Validator

Methods

checkPolicy

checkPolicy(policy: Policy, userContext: KosmosUserContext<object>, action: string): boolean
This function is used to check whether a user action is allowed against a defined Policy

Returns
Parameters
- policy: Policy
  
  The Policy object that the action is to be checked against
- userContext: KosmosUserContext<object>
  
  The corresponding users context
- action: string
  
  The action which is to be checked
Returns boolean
- Defined in src/policies/RolesManager.ts:191

getActionConditionsForRole

getActionConditionsForRole(roleName: string, userContext: KosmosUserContext<object>, action: string): undefined | RuntimeFilter
This function is used to check if a users action has a condition defined.
Parameters
- roleName: string
- userContext: KosmosUserContext<object>
- action: string
Returns undefined | RuntimeFilter
- Defined in src/policies/RolesManager.ts:129

getPolicyActionConditions

getPolicyActionConditions(policy: Policy, userContext: KosmosUserContext<object>, action: string): undefined | RuntimeFilter
Parameters
- policy: Policy
- userContext: KosmosUserContext<object>
- action: string
Returns undefined | RuntimeFilter
- Defined in src/policies/RolesManager.ts:166

load

load(): Promise<void>
Returns Promise<void>
Implementation of EarlyInitializedServiceInterface.load
- Defined in src/policies/RolesManager.ts:37

`Protected` loadRoles

loadRoles(): Promise<{
name: string;
policies: string[];
}[]>
Returns Promise<{
name: string;
policies: string[];
}[]>
- Defined in src/policies/RolesManager.ts:76

validateActionForRole

validateActionForRole(roleName: string, userContext: KosmosUserContext<object>, action: string): boolean
Parameters
- roleName: string
- userContext: KosmosUserContext<object>
- action: string
Returns boolean
- Defined in src/policies/RolesManager.ts:97

Generated using TypeDoc