Class UsageLogger

Logs API key usage with detailed authorization evaluation information

Index

Constructors

constructor

Methods

Log LogDenied LogNoScopesRequired LogSuccess ParseEffectiveFilter ParseEvaluatedRules

Constructors

constructor

new UsageLogger(): UsageLogger
Returns UsageLogger

Methods

Log

Log(
    entry: UsageLogEntry,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<string | null>
Log a usage entry to the database
Parameters
- entry: UsageLogEntry
  The usage log entry to record
- contextUser: UserInfo
  The user context for database operations
- Optionalprovider: IMetadataProvider
Returns Promise<string | null>
The created log entity ID, or null if logging failed
- Defined in APIKeys/Engine/src/UsageLogger.ts:21

LogDenied

LogDenied(
    apiKeyId: string,
    applicationId: string | null,
    endpoint: string,
    operation: string | null,
    method: string,
    statusCode: number,
    responseTimeMs: number | null,
    requestedResource: string | null,
    evaluatedRules: EvaluatedRule[],
    deniedReason: string,
    ipAddress: string | null,
    userAgent: string | null,
    contextUser: UserInfo,
    effectiveFilter?: EffectiveFilterEntry[],
): Promise<string | null>
Log a denied request
Parameters
- apiKeyId: string
- applicationId: string | null
- endpoint: string
- operation: string | null
- method: string
- statusCode: number
- responseTimeMs: number | null
- requestedResource: string | null
- evaluatedRules: EvaluatedRule[]
- deniedReason: string
- ipAddress: string | null
- userAgent: string | null
- contextUser: UserInfo
- OptionaleffectiveFilter: EffectiveFilterEntry[]
Returns Promise<string | null>
- Defined in APIKeys/Engine/src/UsageLogger.ts:91

LogNoScopesRequired

LogNoScopesRequired(
    apiKeyId: string,
    applicationId: string | null,
    endpoint: string,
    operation: string | null,
    method: string,
    statusCode: number,
    responseTimeMs: number | null,
    ipAddress: string | null,
    userAgent: string | null,
    contextUser: UserInfo,
): Promise<string | null>
Log a request that didn't require scope checking
Parameters
- apiKeyId: string
- applicationId: string | null
- endpoint: string
- operation: string | null
- method: string
- statusCode: number
- responseTimeMs: number | null
- ipAddress: string | null
- userAgent: string | null
- contextUser: UserInfo
Returns Promise<string | null>
- Defined in APIKeys/Engine/src/UsageLogger.ts:128

LogSuccess

LogSuccess(
    apiKeyId: string,
    applicationId: string | null,
    endpoint: string,
    operation: string | null,
    method: string,
    statusCode: number,
    responseTimeMs: number | null,
    requestedResource: string | null,
    evaluatedRules: EvaluatedRule[],
    ipAddress: string | null,
    userAgent: string | null,
    contextUser: UserInfo,
    effectiveFilter?: EffectiveFilterEntry[],
): Promise<string | null>
Log a successful request
Parameters
- apiKeyId: string
- applicationId: string | null
- endpoint: string
- operation: string | null
- method: string
- statusCode: number
- responseTimeMs: number | null
- requestedResource: string | null
- evaluatedRules: EvaluatedRule[]
- ipAddress: string | null
- userAgent: string | null
- contextUser: UserInfo
- OptionaleffectiveFilter: EffectiveFilterEntry[]
Returns Promise<string | null>
- Defined in APIKeys/Engine/src/UsageLogger.ts:55

`Static`ParseEffectiveFilter

ParseEffectiveFilter(json: string | null): EffectiveFilterEntry[]
Parse the effective row filter recorded alongside the evaluated rules, or an empty array when the log entry carries none.
Parameters
- json: string | null
Returns EffectiveFilterEntry[]
- Defined in APIKeys/Engine/src/UsageLogger.ts:194

`Static`ParseEvaluatedRules

ParseEvaluatedRules(json: string | null): EvaluatedRule[]
Parse evaluated rules from JSON storage
Parameters
- json: string | null
Returns EvaluatedRule[]
- Defined in APIKeys/Engine/src/UsageLogger.ts:214

Class UsageLogger

Index

Constructors

Methods

Constructors

constructor

Returns UsageLogger

Methods

Log

Parameters

Returns Promise<string | null>

LogDenied

Parameters

Returns Promise<string | null>

LogNoScopesRequired

Parameters

Returns Promise<string | null>

LogSuccess

Parameters

Returns Promise<string | null>

`Static`ParseEffectiveFilter

Parameters

Returns EffectiveFilterEntry[]

`Static`ParseEvaluatedRules

Parameters

Returns EvaluatedRule[]

Settings

On This Page

Class UsageLogger

Index

Constructors

Methods

Constructors

constructor

Returns UsageLogger

Methods

Log

Parameters

Returns Promise<string | null>

LogDenied

Parameters

Returns Promise<string | null>

LogNoScopesRequired

Parameters

Returns Promise<string | null>

LogSuccess

Parameters

Returns Promise<string | null>

StaticParseEffectiveFilter

Parameters

Returns EffectiveFilterEntry[]

StaticParseEvaluatedRules

Parameters

Returns EvaluatedRule[]

Settings

On This Page

`Static`ParseEffectiveFilter

`Static`ParseEvaluatedRules