RelayrtcDocs
Get started
Documentation
Node SDK

Room access and audit methods

Manage roles and permission ceilings and read room history from your backend.

These source additions extend RelayServer. They require an updated API deployment and migration 0045_room_access.

MethodReturnsScope
participants.getAccess(roomId, participantId, options?)ParticipantAccessparticipants:read
participants.updateAccess(roomId, participantId, input, options?)ParticipantAccessparticipants:write
rooms.audit(roomId, query?, options?)RoomAuditPagerooms:read

UpdateParticipantAccess requires version, role and allowedPermissions. RoomRole, RoomParticipantPermission, ParticipantAccess, UpdateParticipantAccess, RoomAuditEvent, RoomAuditQuery, RoomAuditPage and roomParticipantPermissions are exported from @relayrtc/node. Standard request options apply.

TypeScript
const access = await relay.participants.getAccess(roomId, participantId)
await relay.participants.updateAccess(roomId, participantId, {
  version: access.version,
  role: 'moderator',
  allowedPermissions: access.allowedPermissions,
})
 
const first = await relay.rooms.audit(roomId, { limit: 25 })
const next = first.pageInfo.hasNextPage && first.pageInfo.endCursor
  ? await relay.rooms.audit(roomId, { limit: 25, ...first.pageInfo.endCursor })
  : null

On ROOM_ACCESS_CONFLICT, reload policy before presenting another save. Do not retry stale writes as though they were unconditional updates. A saved ceiling cannot add permissions absent from the token. See the role guide and REST contract for host transfer and enforcement timing.