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.
PATCH /{namespace}/ permissions/ {id}Path: id. Body, as JSON: the other inputs. 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
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"}'{
"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.
DELETE /{namespace}/ permissions/ {id}Path: id. 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
curl -X DELETE https: //api.sb/ leaseline.app/ permissions/ permission_1IFL54Tlfx \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"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"
}
}