Skip to main content

ToolkitAuth

@forge/monorepo

@forge/monorepo / backend/src / ToolkitAuth

Type Alias: ToolkitAuth

ToolkitAuth = object

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

What a toolkit accepts — #260 AC-2.

Declared by the toolkit and checked at construction, so wiring a Basic-auth vendor with a bearer token is a startup error naming both, rather than a vendor 401 an hour later whose message says the token is invalid.

modes is the other axis and is not the platform's business to validate — it is a fact about the vendor that a deployment reads: "GitHub takes a PAT or OAuth", "Google is OAuth only". #262 uses it to decide which connection flows to offer, and #264 uses it to decide whether an unconnected tool can pause a run for consent or must simply fail, since a token has no login URL.

Properties​

modes​

readonly modes: readonly AuthMode[]

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

How a tenant may obtain the credential.

schemes​

readonly schemes: readonly CredentialScheme[]

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

The scheme(s) this toolkit can present. A credential of any other scheme is refused.