Interface IAuthorizer<T>

Authorizer to perform role based checks for a principal.

Param: U

Principal data type, the type must extend Principal

interface IAuthorizer<T extends Principal> {
name: string;
authorize(principal: T, role: string): Promise<boolean>;
}

Type Parameters

T extends Principal

Index

Properties

Methods

Properties

`Readonly`name

name: string

A human readable name for this authorizer.

Methods

authorize

authorize(principal: T, role: string): Promise<boolean>
Check that a principal has a named role.
Parameters
- principal: T
  The current principal context.
- role: string
  The name of the role to check for.
Returns Promise<boolean>
true if the principal is authorised to use the name role, otherwise false.
- Defined in api/security/IAuthorizer.ts:21