Skip to main content

CredentialAudit

@forge/monorepo


@forge/monorepo / backend/src / CredentialAudit

Interface: CredentialAudit

Defined in: backend/src/tools/credentials.ts:151

Told about every resolution — docs/21's Connections section, "an audit record of every resolution".

A sink rather than a return value, so a toolkit cannot forget to report and a host cannot be surprised by one. Both outcomes are reported: a refused resolution is the more interesting audit event, because a successful one is the normal case and a refused one is somebody asking for something they do not have.

It never receives the credential. An audit trail that carries the secret is a second copy of the secret in a place designed to be kept for a long time.

Methods

onRefused()

onRefused(input): void | Promise<void>

Defined in: backend/src/tools/credentials.ts:157

Parameters

input
context

ExecutionContext

reason

string

ref

string

Returns

void | Promise<void>


onResolved()

onResolved(input): void | Promise<void>

Defined in: backend/src/tools/credentials.ts:152

Parameters

input
context

ExecutionContext

ref

string

scheme

"bearer" | "basic" | "custom-header"

Returns

void | Promise<void>