Skip to content

by Startups.Studio

Team Permission

Permission.create

POST /{namespace}/permissions

Creates a Permission.

Noun: Permission
Mode: do
Event: Permission.created

You, to your agent

Add a permission to PatentPad.

curl -X POST https://api.sb/patentpad.com/permissions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"Example scope"}'

import { $ } from 'startup-builder'

const permission = await $.Permission.create({ scope: 'Example scope' })

npx startup-builder do Permission.create --json '{"scope":"Example scope"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Permission.create({ scope: 'Example scope' })"
  }
}

Create makes a new Permission from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`scope`	`string`	required	Where it applies, such as a Startup or a Tenant.
`limit`	Limit		The Limit that bounds it.
`role`	Role		A Role’s Permissions are what its Worker may do: Verbs on Nouns within a scope and a Limit.
`verb`	Verb		Each Permission allows one Verb, within its scope and Limit.

Outputs

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

Effects

Emits Permission.created.
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.create

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

Previous Page

Permission.delete

Next Page