Digital Samba Embedded
  • Introduction
  • SDK
    • DigitalSambaEmbedded class
    • Methods
      • addCustomTile()
      • removeCustomTile()
      • addFrameEventListener()
      • addImageToWhiteboard()
      • addTileAction()
      • addUICallback()
      • allowBroadcast()
      • allowScreenshare()
      • changeBrandingOptions()
      • changeLayoutMode()
      • changeRole()
      • changeToolbarPosition()
      • closeLibraryFile()
      • closeWhiteboard()
      • createWhiteboard()
      • configureCaptions()
      • configureVirtualBackground()
      • disableAudio()
      • disableVideo()
      • disableVirtualBackground()
      • disallowBroadcast()
      • disallowScreenshare()
      • enableAudio()
      • enableVideo()
      • enableVirtualBackground()
      • endSession()
      • featureEnabled()
      • hideCaptions()
      • hideToolbar()
      • leaveSession()
      • listUsers()
      • load()
      • lowerHand()
      • muteFrame()
      • maximizeLocalTile()
      • maximizeUser()
      • minimizeLocalTile()
      • minimizeContent()
      • minimizeUser()
      • off()
      • on()
      • once()
      • openLibraryFile()
      • openWhiteboard()
      • pinUser()
      • raiseHand()
      • removeFrameEventListener()
      • removeTileAction()
      • removeUICallback()
      • removeUser()
      • requestMute()
      • requestToggleAudio()
      • requestUnmute()
      • showCaptions()
      • showToolbar()
      • startRecording()
      • startScreenshare()
      • stopRecording()
      • stopScreenshare()
      • toggleAudio()
      • toggleCaptions()
      • toggleMuteFrame()
      • toggleToolbar()
      • toggleVideo()
      • toggleWhiteboard()
      • toggleLibraryFile()
      • unmuteFrame()
      • unpinUser()
    • Events
      • activeSpeakerChanged
      • appError
      • appLanguageChanged
      • audioDisabled
      • audioEnabled
      • captionsDisabled
      • captionsEnabled
      • captionsFontSizeChanged
      • captionsSpokenLanguageChanged
      • chatMessageReceived
      • featureSetUpdated
      • frameLoaded
      • handRaised
      • handLowered
      • layoutModeChanged
      • mediaDeviceChanged
      • permissionsChanged
      • recordingFailed
      • recordingStarted
      • recordingStopped
      • roleChanged
      • roomStateUpdated
      • screenshareStarted
      • screenshareStopped
      • sessionEnded
      • speakerStoppedTalking
      • userJoined
      • userLeft
      • usersUpdated
      • videoDisabled
      • videoEnabled
      • virtualBackgroundChanged
      • virtualBackgroundDisabled
    • Properties
      • features
      • localUser
      • permissionManager
      • roomState
  • REST API
    • Rate limiting
    • Pagination
    • Default room settings
      • List
      • Edit
    • Rooms
      • Create
      • Edit
      • List
      • Delete
        • All resources
        • Concrete resource
      • Files
      • Chat
        • List
        • Export
      • Questions & Answers
        • List
        • Export
      • Transcription
        • List
        • Export
        • Start
        • Stop
    • Sessions
      • List
      • End
      • Delete resources
        • All resources
        • Concrete resource
      • Transcripts
      • Summary (AI)
    • Participants
      • List
    • Roles and permissions
      • Permissions
      • Create
      • Edit
      • List
      • Delete
    • Live usage
      • Rooms
      • Participants
    • Statistics
      • Current period
      • Team
      • Room
    • Tokens
      • Properties
      • Create
    • Recordings
      • List
      • Download
      • Start
      • Stop
      • Delete
      • Archive
      • Unarchive
    • Polls
      • Create
      • Edit
      • List
      • Delete
      • Export
      • Results
    • Content Library
      • Create
      • Edit
      • List
      • Delete
      • Folders
        • Create
        • Edit
        • List
        • Delete
      • Files
        • Upload
        • Webapps
        • Whiteboards
        • Edit
        • List
        • Delete
    • Telephony
      • Participant Join
      • Participant Leave
    • Webhooks
      • Payload structure
      • Create
      • Edit
      • List
      • Delete
    • Scribe / Postman docs
  • Dashboard docs
  • LTI docs
Powered by GitBook
On this page
  1. REST API
  2. Roles and permissions

Permissions

A role is a set of permissions. Each permission configures if the concrete action is allowed inside the room. So when configuring a role you select which actions a participant with that role is allowed to perform.

Some of the permissions are Role-sensitive which means you can enable that permission to be applied only to a concrete set of target roles. For example you may want a speaker to be allowed to remove an attendee from the meeting, but not to be allowed to remove a moderator. In that case when you configure the Speaker role, you will list only the attendee role as a target role for the Remove participants permission.

Here is a list of the supported permission names:

  • broadcast Allowed to use their camera and microphone to broadcast.

  • manage_broadcast Role-sensitive Allowed to give and remove broadcast permission and lower raised hands of the selected roles.

  • start_session Allowed to start sessions.

  • end_session Allowed to end the session for everyone.

  • remove_participant Role-sensitive Allowed to remove participants with selected roles from the session.

  • screenshare Allowed to share their screen's video and audio.

  • manage_screenshare Role-sensitive Allowed to give and remove screenshare permission to the selected roles.

  • recording Allowed to start and stop recordings.

  • general_chat Allowed to chat openly in the general chat.

  • private_chat Allowed to chat privately 1-to-1 with other participants

  • remote_muting Role-sensitive Allowed to remotely mute or turn off camera of participants with with the selected roles.

  • ask_remote_unmute Role-sensitive Allowed to remotely ask selected roles to unmute or turn on camera.

  • raise_hand Allowed to raise their hand to request broadcast permissions or take turns to speak.

  • manage_roles Role-sensitive

    Allowed to move participants between the selected roles.

  • control_room_entry Allowed to admit / reject participants who wait to enter the room.

  • see_participants_panel Allowed to see the participants panel and receive join/leave notifications

  • invite_participant Allowed to invite participants into the session.

  • edit_whiteboard Allowed to edit the whiteboard - make drawings, etc...

  • manage_edit_whiteboard Role-sensitive Allowed to give and remove edit whiteboard permission to the selected roles.

  • manage_breakout Allowed to start/stop breakout rooms and manage assignment of participants to breakout

  • answer_qa Allowed to answer questions

  • moderate_qa Allowed to delete questions and answers of other participants

  • upvote_qa Allowed to upvote questions

  • present_files Allowed to present (open) files, so other participants can see the slides.

  • control_room_components Allowed to dynamically enable/disable room components. For example to enable/disable Chat, Questions & Answers and Whiteboard on the fly while a session is running in the room.

  • manage_polls Allowed to create/edit/start/end/share polls

  • take_polls Allowed to vote in (take) polls

  • transcribe_session Allowed to start and stop transcription for a live session

PreviousRoles and permissionsNextCreate

Last updated 9 months ago