Credential methods: update, delete

Reference for Credential, one group of Credential methods.

Credential.update

Changes the given properties of a Credential. Verb page.

TypeScript

interface CredentialVerbs {
  update(input: CredentialUpdateInput, options?: SB.CallOptions): SB.Call<Credential>
}

Emits Credential.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Credential.
`issuer`	`string`		The regulator or registry that grants it.
`jurisdiction`	`string`		Where it applies.
`standing`	`string`		Whether it is in good standing, read fresh on every use.

Returns

Output	Type	Required	Description
`credential`	Credential	required	The Credential.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const credential = await $.Credential.update({ id: 'credential_Abb9zatRR1', jurisdiction: 'US-DE' })

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

TypeScript

interface CredentialVerbs {
  delete(input: CredentialDeleteInput, options?: SB.CallOptions): SB.Call<Credential>
}

Emits Credential.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Credential.

Returns

Output	Type	Required	Description
`credential`	Credential	required	The Credential.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const credential = await $.Credential.delete({ id: 'credential_Abb9zatRR1' })