Skip to content

Permission routes: update, delete

The Permission Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Permission, one group of Permission routes.

Permission.update

Changes the given properties of a Permission. Verb page.

Text
PATCH /{namespace}/permissions/{id}

Path: id. Body, as JSON: the other inputs. Emits Permission.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Permission.
scopestringWhere it applies, such as a Startup or a Tenant.
limitLimitThe Limit that bounds it.

Returns

OutputTypeRequiredDescription
permissionPermissionrequiredThe Permission.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/permissions/permission_1IFL54Tlfx \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"limit_UWHXYVKsJB"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "permission": {
    "$id": "https://api.sb/leaseline.app/permissions/permission_1IFL54Tlfx",
    "$type": "Permission",
    "scope": "Example scope",
    "limit": "limit_UWHXYVKsJB"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Permission.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Permission.delete

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

Text
DELETE /{namespace}/permissions/{id}

Path: id. Emits Permission.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Permission.

Returns

OutputTypeRequiredDescription
permissionPermissionrequiredThe Permission.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/permissions/permission_1IFL54Tlfx \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "permission": {
    "$id": "https://api.sb/leaseline.app/permissions/permission_1IFL54Tlfx",
    "$type": "Permission",
    "scope": "Example scope"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Permission.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}