Skip to content

credential

FieldValue
Prefixcredential
Namespace constantCredentialNamespace
Subjects constantCredentialSubjects
Kindbus
Schema recordCredentialSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/credential/namespace.ts
KeyWireTypeSchema
activatecredential.activaterpc
changedcredential.changedrpc
deletecredential.deleterpc
existscredential.existsrpc
getcredential.getrpc
getChannelTokencredential.getChannelTokenrpc
resolvecredential.resolverpc
storecredential.storerpc

Pre-resolution activation hook for credential extensions.

Emitted before resolveConnectorCredentials() runs so extensions (e.g., account-manager) can prepare native credential stores. Awaited before credential resolution — handler failures are suppressed (errors cannot block agent start), but completion is guaranteed before resolveConnectorCredentials() runs.

Subject: credential.activate Type: Request (RPC)

Request:

FieldTypeRequired
credentialRefsRecord<string, string & $brand<"CredentialRef">>yes
definitionIdstringyes
providerConfigIdstringyes

Response:

Empty object.

Mid-session credential rotation signal.

Emitted when credential state changes during active sessions. The orchestrator fans this out to affected agents.

Subject: credential.changed Type: Request (RPC)

Request:

FieldTypeRequired
changeSequencenumberyes
credentialRefsRecord<string, string & $brand<"CredentialRef">>yes
definitionIdstringyes
providerConfigIdstringyes
sessionIdstringyes

Response:

Empty object.

Delete stored credentials for a provider config.

Subject: credential.delete Type: Request (RPC)

Request:

FieldTypeRequired
configIdstringyes

Response:

FieldTypeRequired
deletedbooleanyes

Check whether credentials exist for a provider config.

Subject: credential.exists Type: Request (RPC)

Request:

FieldTypeRequired
configIdstringyes

Response:

FieldTypeRequired
existsbooleanyes

Retrieve stored credentials for a provider config. Channel-only — carries sensitive credential data.

Subject: credential.get Type: Request (RPC)

Request:

FieldTypeRequired
configIdstringyes

Response:

FieldTypeRequired
credentialsRecord<string, string> | nullyes

Request the credential channel capability token (local-only).

The token grants access to encrypted credential operations. This subject is local-only to prevent the token from leaking to remote transports. The runtime distributes this token only to authorized services during initialization.

Subject: credential.getChannelToken Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
tokenstringyes

Resolve a credential reference to its plaintext value. Channel-only — the resolved value is sensitive.

Subject: credential.resolve Type: Request (RPC)

Request:

FieldTypeRequired
refstring & $brand<"CredentialRef">yes

Response:

FieldTypeRequired
errorstring | undefinedno
valuestring | nullyes

Store credentials for a provider config. Channel-only — carries sensitive credential data.

Subject: credential.store Type: Request (RPC)

Request:

FieldTypeRequired
configIdstringyes
credentialsRecord<string, string>yes

Response:

Empty object.


Auto-generated by yarn docs:bus. Do not edit manually.