Credential methods: create, get, list

Reference for Credential, one group of Credential methods.

Credential.create

Creates a Credential. Verb page.

TypeScript

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

Emits Credential.created.

Inputs

Input	Type	Required	Description
`issuer`	`string`	required	The regulator or registry that grants it.
`jurisdiction`	`string`	required	Where it applies.
`standing`	`string`		Whether it is in good standing, read fresh on every use.
`supplier`	Supplier		The Credentials a Supplier holds decide which Reserved Acts it may perform; standing is read fresh on every use.
`worker`	Worker		A Worker performs a Reserved Act only while it holds the Credential that authorizes it, in good standing.

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.create({ issuer: 'Example issuer', jurisdiction: 'US-DE' })

Returns one Credential by id. Verb page.

TypeScript

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

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Credential.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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.get({ id: 'credential_Abb9zatRR1' })

Returns Credentials, newest first, one page at a time. Verb page.

TypeScript

interface CredentialVerbs {
  list(input?: CredentialListInput, options?: SB.CallOptions): SB.ListCall<Credential>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`credentials`	list of Credential	required	One page of Credentials.

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 credentials = await $.Credential.list({ limit: 20 })