Interface IAuthorizer<T>

Authorizer to perform role based checks for a principal.

Param

Principal data type, the type must extend Principal

Type Parameters

Hierarchy

  • IAuthorizer

Properties

name

Methods

authorize

Properties

Readonly name

name: string

A human readable name for this authorizer.

Methods

authorize

  • 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc