Skip to main content

Function: RequiresScope()

RequiresScope(scopes): (target, propertyKey, descriptor) => void

Defined in: service-core/src/decorators/RouteDecorators.ts:368

Indicates that the client's token must carry at least one of the specified OAuth-style scope(s) to process the request. This is a coarse, token-level pre-check performed before the per-resource AccessControlList check — it answers "can this token ever perform this class of action" rather than "can this user perform this action on this specific resource".

Parameters

scopes

string | string[]

The scope(s) that the authenticated user's token must carry to make the request. The sentinel value ACLAction.FULL ("*") also satisfies any required scope.

Returns

(target, propertyKey, descriptor) => void