VaultAPI
Defined in: namespaces-core-plugins.ts:138
Credential vault (fn-72). Anti-enumeration applies on use(ref:) —
unknown refs collapse to a sanitized error.
Scopes: vault.store, vault.read, vault.list, vault.share,
vault.audit, plus contributor scopes
vault.{type,bridge,rotator}.register and vault.policy.contribute.
fn-72
Methods
Section titled “Methods”store()
Section titled “store()”store(
kind,label,material):Promise<CredentialRef>
Defined in: namespaces-core-plugins.ts:140
Stores credential material; returns an opaque ref. [vault.store]
Parameters
Section titled “Parameters”string
string
material
Section titled “material”Returns
Section titled “Returns”Promise<CredentialRef>
find()
Section titled “find()”find(
kind?,label?,source?):Promise<CredentialRef[]>
Defined in: namespaces-core-plugins.ts:142
Finds credential refs by kind/label/source. [vault.list]
Parameters
Section titled “Parameters”string
label?
Section titled “label?”string
source?
Section titled “source?”string
Returns
Section titled “Returns”Promise<CredentialRef[]>
use<
T>(refId,purpose,body):Promise<T>
Defined in: namespaces-core-plugins.ts:144
Uses a credential inside a scoped callback. [vault.read]
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
purpose
Section titled “purpose”string
(handle) => T | Promise<T>
Returns
Section titled “Returns”Promise<T>
buildRequest()
Section titled “buildRequest()”buildRequest(
handleId,descriptor):Promise<string>
Defined in: namespaces-core-plugins.ts:150
Builds a server-held URLRequest from a credential handle. Returns a
single-use requestId for network.executeRequest — JS never sees the
raw token.
Parameters
Section titled “Parameters”handleId
Section titled “handleId”string
descriptor
Section titled “descriptor”Returns
Section titled “Returns”Promise<string>
injectHeader()
Section titled “injectHeader()”injectHeader(
handleId,requestId,headerName,scheme):Promise<string>
Defined in: namespaces-core-plugins.ts:155
Injects an auth header into a server-held request. Returns a NEW requestId; the old one is consumed.
Parameters
Section titled “Parameters”handleId
Section titled “handleId”string
requestId
Section titled “requestId”string
headerName
Section titled “headerName”string
scheme
Section titled “scheme”string
Returns
Section titled “Returns”Promise<string>
rotate()
Section titled “rotate()”rotate(
refId):Promise<void>
Defined in: namespaces-core-plugins.ts:157
Rotates credential material behind a ref.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
revoke()
Section titled “revoke()”revoke(
refId):Promise<void>
Defined in: namespaces-core-plugins.ts:159
Revokes a credential ref.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>