Class ScopeEvaluator

Evaluates API key authorization using two-level scope evaluation:

Application Ceiling (APIApplicationScope) - what the app allows
Key Scopes (APIKeyScope) - what the key grants

Both levels support pattern matching with Include/Exclude and Deny rules. Deny rules always trump Allow rules at the same priority level.

This class now uses APIKeysEngineBase for cached metadata access, eliminating redundant per-request database queries.

Index

Constructors

Accessors

Methods

ClearCache EvaluateAccess GetKeyApplications

Constructors

constructor

new ScopeEvaluator(defaultBehaviorNoScopes?: "allow" | "deny"): ScopeEvaluator
Parameters
- defaultBehaviorNoScopes: "allow" | "deny" = 'allow'
Returns ScopeEvaluator
- Defined in APIKeys/Engine/src/ScopeEvaluator.ts:49

Accessors

`Protected`Base

get Base(): APIKeysEngineBase
Access to the cached metadata from APIKeysEngineBase

Returns APIKeysEngineBase
- Defined in APIKeys/Engine/src/ScopeEvaluator.ts:56

Methods

ClearCache

ClearCache(): void
Clear cache - delegates to Base engine

Returns void
Deprecated
Use APIKeysEngineBase.Instance.Config(true) to force refresh instead
- Defined in APIKeys/Engine/src/ScopeEvaluator.ts:126

EvaluateAccess

EvaluateAccess(
request: AuthorizationRequest,
_contextUser: UserInfo,
): Promise<AuthorizationResult>
Evaluate authorization for a request. Uses cached metadata from APIKeysEngineBase.
Parameters
- request: AuthorizationRequest
  The authorization request
- _contextUser: UserInfo
  The user context (kept for API compatibility)
Returns Promise<AuthorizationResult>
Authorization result with detailed evaluation info
- Defined in APIKeys/Engine/src/ScopeEvaluator.ts:67

GetKeyApplications

GetKeyApplications(
apiKeyId: string,
_contextUser: UserInfo,
): Promise<MJAPIKeyApplicationEntity[]>
Get applications bound to a key. Uses cached data from APIKeysEngineBase.
Parameters
- apiKeyId: string
  The API key ID
- _contextUser: UserInfo
  Kept for API compatibility
Returns Promise<MJAPIKeyApplicationEntity[]>
- Defined in APIKeys/Engine/src/ScopeEvaluator.ts:287