Class PolicyBuilder

Fluent builder for composing AuthorizationPolicy instances.

Example

const policy = new PolicyBuilder()
    .requireRole('admin')
    .require(p => p.hasClaim('verified', 'true'))
    .build('admin-only');

Index

Constructors

Methods

build require requireRole

Constructors

constructor

new PolicyBuilder(): PolicyBuilder
Returns PolicyBuilder

Methods

build

build(name: string): AuthorizationPolicy
Finalize the policy with the given name.
Parameters
- name: string
Returns AuthorizationPolicy
- Defined in Authorization.ts:73

require

require(requirement: AuthorizationRequirement): this
Add an arbitrary predicate requirement.
Parameters
- requirement: AuthorizationRequirement
Returns this
- Defined in Authorization.ts:67

requireRole

requireRole(...roles: string[]): this
Add a role requirement: at least one of roles must be held by the principal.
Parameters
- ...roles: string[]
Returns this
- Defined in Authorization.ts:61