As mentioned above, when you request authorization from users, the URL scope parameter allows you to specify which permissions your app requires. These scopes are tied to the access token you receive on successful authorization. Multiple scopes can be specified when requesting an OAuth or OIDC token. Without specifying scopes, your app can access only basic information about the authenticated user.
Scopes are specified as a space-separated list in the URL scope parameter, when requesting authorization:
GET (URL ENCODED)
&scope=user:edit%20user:read:email
https://auth.brime.tv/authorize
?client_id=<your client ID>
&redirect_uri=<your registered redirect URI>
&response_type=<type>
&scope=user:edit%20user:read:email
- Ask only for the permissions you need
- Users can view each requested permission when authorizing your app
- No scopes are needed when requesting app access tokens
User Scopes
The tables below display a comprehensive list of the available scopes for the Brime API:
| Scope | Description |
|---|---|
| user:edit | Manage a user object. User Preferences |
| user:read:follows | View the list of channels a user follows. Get Followed Streams |
Channel Scopes
| Scope | Description |
|---|---|
| channel:read:stream_key | View an authorized user’s stream key. |
| channel:read:subscriptions | View a list of all subscribers to a channel and check if a user is subscribed to a channel. |
| channel:manage:videos | Manage Videos for a channel. |
| clips:edit | Manage Clips for a channel. |
| moderation:read | View a channel’s moderation data including Moderators, Bans, Timeouts, and Automod settings. |
| channel:manage:broadcast | Manage a channel’s broadcast configuration, including updating channel configuration and managing stream markers and stream tags. |
Chat Scopes
| Scope | Description |
|---|---|
| moderator:read:chat_settings | View a broadcaster’s chat room settings. |
| moderator:manage:chat_settings | Manage a broadcaster’s chat room settings. |