Skip to content

Permission

A Permission is what a Role may do: a Verb on a Noun within a scope, optionally bounded by a Limit.

Properties

PropertyTypeRequiredDescription
scopestringrequiredWhere it applies, such as a Startup or a Tenant.
limitLimitThe Limit that bounds it.

Object

JSON
{
  "$id": "https://api.sb/ledgerlark.com/permissions/permission_1",
  "$type": "Permission",
  "scope": "Example scope",
  "limit": "limit_1"
}

Relationships

Verbs

  1. createCreates a Permission.
    POST /{namespace}/permissionsdoPermission.created
  2. getReturns one Permission by id.
    GET /{namespace}/permissions/{id}readNo Event
  3. listReturns Permissions, newest first, one page at a time.
    GET /{namespace}/permissionsreadNo Event
  4. updateChanges the given properties of a Permission.
    PATCH /{namespace}/permissions/{id}doPermission.updated
  5. deleteDeletes a Permission; its history is kept.
    DELETE /{namespace}/permissions/{id}doPermission.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Permission.createYesYesNoNo
Permission.getYesYesYesYes
Permission.listYesYesYesYes
Permission.updateYesYesNoNo
Permission.deleteYesYesNoNo

Call it

Text
Add a permission to PatentPad.

Example

The Billing Specialist Role holds a Permission to refund on Order, within a $100 Limit.