Skip to content

Credential commands: update, delete

The Credential Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Credential, one group of Credential commands.

Credential.update

Changes the given properties of a Credential. Verb page.

Text
npx startup-builder do Credential.update --json '<input>' [--try | --send | --do]

Emits Credential.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Credential.
issuerstringThe regulator or registry that grants it.
jurisdictionstringWhere it applies.
standingstringWhether it is in good standing, read fresh on every use.

Returns

OutputTypeRequiredDescription
credentialCredentialrequiredThe Credential.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Credential.update --json '{"id":"credential_Abb9zatRR1","jurisdiction":"US-DE"}'

Credential.delete

Deletes a Credential: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Credential.delete --json '<input>' [--try | --send | --do]

Emits Credential.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Credential.

Returns

OutputTypeRequiredDescription
credentialCredentialrequiredThe Credential.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Credential.delete --json '{"id":"credential_Abb9zatRR1"}'