Permission methods: update, delete

Reference for Permission, one group of Permission methods.

Permission.update

Changes the given properties of a Permission. Verb page.

TypeScript

interface PermissionVerbs {
  update(input: PermissionUpdateInput, options?: SB.CallOptions): SB.Call<Permission>
}

Emits Permission.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Permission.
`scope`	`string`		Where it applies, such as a Startup or a Tenant.
`limit`	Limit		The Limit that bounds it.

Returns

Output	Type	Required	Description
`permission`	Permission	required	The Permission.

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 permission = await $.Permission.update({ id: 'permission_1IFL54Tlfx', limit: 'limit_UWHXYVKsJB' })

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

TypeScript

interface PermissionVerbs {
  delete(input: PermissionDeleteInput, options?: SB.CallOptions): SB.Call<Permission>
}

Emits Permission.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`permission`	Permission	required	The Permission.

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 permission = await $.Permission.delete({ id: 'permission_1IFL54Tlfx' })