Skip to main content

index/variables/API_KEY_PERMISSION.md

const API_KEY_PERMISSION: object

API Key permission enumeration

Fine-grained permissions that can be assigned to API keys. Permissions vary based on the role assigned to the key.

Type Declaration​

NameTypeDescription
BAN_USERS"BAN_USERS"Ban users from streams
DELETE_RECORDINGS"DELETE_RECORDINGS"Delete stream recordings
GET_STREAM_KEY"GET_STREAM_KEY"Get stream key
MANAGE_CHAT"MANAGE_CHAT"Manage chat messages (send/delete)
MANAGE_COMMENTS"MANAGE_COMMENTS"Manage comments (create/delete)
MANAGE_SIMULCAST"MANAGE_SIMULCAST"Manage simulcast targets
MANAGE_STREAM_SETTINGS"MANAGE_STREAM_SETTINGS"Manage stream settings (countdown, language)
RESET_STREAM_KEY"RESET_STREAM_KEY"Reset stream key
START_STREAM"START_STREAM"Start new stream
STOP_STREAM"STOP_STREAM"Stop active stream
UNBAN_USERS"UNBAN_USERS"Unban users from streams

Since​

6.x.0