52bf0279Scoped permission assignment#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | grantPermissions |
| Method | GET |
| Path | /api/agents/{agentId}/room-grants/{roomId}/permissions |
| Authentication | human |
| Success status | 200 |
| Response data | Unpaginated value |
| Request format | json |
| Maximum request body | 2097152 bytes (service default) |
| Permission codes | agent.read.owned, agent.read.any |
Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.
Path parameters#
object; fields below; unknown fields rejected
| Field path | Representation and constraints |
|---|---|
agentId | lowercase opaque UUID |
roomId | immutable Matrix room ID; maximum 255 UTF-16 units |
Validation#
check.object({ agentId: check.identifier, roomId: check.roomId })Referenced definitions:
Query parameters#
custom validation:
none
; see function below
Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.
Additional checks#
The following checks apply in addition to the field limits.
Constraint on value:
export function none(input: unknown) {
const parsed = listQuery([])(input);
return parsed.ok ? success({}) : parsed;
}Validation#
query.noneReferenced definitions:
Request body#
empty object; unknown fields rejected
Validation#
check.emptyReferenced definitions:
Response data#
object; fields below; unknown fields rejected (
grantView
)
| Field path | Representation and constraints |
|---|---|
agentId | lowercase opaque UUID |
revision | exact JSON integer; 0…9007199254740991 |
grant | object; fields below; unknown fields rejected (
grant
); JSON null permitted |
grant.agentId | lowercase opaque UUID |
grant.roomId | immutable Matrix room ID; maximum 255 UTF-16 units |
grant.generation | lowercase opaque UUID |
grant.authorizerId | lowercase opaque UUID |
grant.addedById | lowercase opaque UUID |
grant.accessMode | none or read or reply or custom |
grant.powerLevel | exact JSON integer; -9007199254740991…9007199254740991; JSON null permitted |
grant.muted | boolean |
grant.revision | exact JSON integer; 0…9007199254740991 |
grant.accessRevision | exact JSON integer; 0…9007199254740991 |
grant.updatedAt | exact JSON integer; 0…9007199254740991 |
ownerConversation | boolean |
application | object; fields below; unknown fields rejected; constraint: Native creators have no finite power level (
grantApplication
); JSON null permitted |
application.observedGeneration | lowercase opaque UUID; JSON null permitted |
application.appliedRevision | exact JSON integer; 0…9007199254740991; JSON null permitted |
application.appliedAccessRevision | exact JSON integer; 0…9007199254740991; JSON null permitted |
application.membership | join or invite or leave or ban; JSON null permitted |
application.creator | boolean |
application.powerLevel | exact JSON integer; -9007199254740991…9007199254740991; JSON null permitted |
application.lastAttemptAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
application.lastSuccessAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
application.errorCode | string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
application.errorMessage | string; 1–4096 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
permissions | array; 0–1 entries; item: room.agent.invite |
allowedActions | array; 0–3 entries; item: set or remove or permissions.set |
Additional checks#
The following checks apply in addition to the field limits.
Constraint on application:
application => !application.creator || application.powerLevel === nullValidation#
res.grantViewReferenced definitions:
Response envelope#
A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.
{
"data": "<value matching the response-data validator>",
"meta": {
"requestId": "00000000-0000-0000-0000-000000000001"
}
}