Skip to content

by Startups.Studio

Team Permission

Permission.update

PATCH /{namespace}/permissions/{id}

Changes the given properties of a Permission.

Noun: Permission
Mode: do
Event: Permission.updated

You, to your agent

Change the latest permission.

curl -X PATCH https://api.sb/petpantry.shop/permissions/permission_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"limit_1"}'

import { $ } from 'startup-builder'

const permission = await $.Permission.update({ id: 'permission_1', limit: 'limit_1' })

npx startup-builder do Permission.update --json '{"id":"permission_1","limit":"limit_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Permission.update({ id: 'permission_1', limit: 'limit_1' })"
  }
}

Update changes the given properties of a Permission. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

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

Effects

Emits Permission.updated.
Two-way: try, send, do.

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.	Permission.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Permission.list

Previous Page

Role

Next Page