API Scopes

OAuth2 scopes define the level of access granted to an API token. Scopes can be requested individually or via bundles, which are predefined role-oriented templates that expand to a set of scopes.

📘
You are reading API v2 documentation
Still using the Legacy API? Access the Legacy API documentation.

Request an access token with scopes

👍
Note
bundle.organization grants the broadest set of permissions. Request individual scopes if your integration requires restricted access.

Bundles

Bundles are predefined templates that expand into a set of scopes.

BUNDLE	INCLUDED SCOPES	DESCRIPTION
`bundle.public`	`playlist.read` `profile.read` `video.read`	Read-only access to public content. Suits integrations that only need to browse public data.
`bundle.user`	All `public` scopes + `account.manage` `live.manage` `playlist.manage` `profile.manage` `video.manage`	Extends `public` with full write permissions for a logged-in user. Suits user-facing applications that manage content and personal data on behalf of the user.
`bundle.publisher`	All `user` scopes + `player.manage`	Extends `user` with permissions for managing analytics and Players. Designed for publishers embedding content on their property.
`bundle.organization`	All `publisher` scopes + `organization.manage`	Extends `publisher` and allows Organization management with users, API keys, SSO, and contract management.

Scopes

Each scope expands to a set of granular IAM permissions. Scopes can be requested individually when a bundle is too broad for your needs.

To request multiple scopes, separate them by a space (eg. video.manage player.manage).

SCOPE	DESCRIPTION
`account.manage`	Full access to user account management: reading, updating, and deleting user account information.
`account.read`	Read-only access to user account information.
`live.manage`	Full access to live event management: creating, reading, updating, and deleting live events.
`live.read`	Read-only access to live event information.
`player.create`	Allows creating new Player configurations.
`player.delete`	Allows deleting Player configurations.
`player.manage`	Full access to Player management: creating, reading, updating, and deleting Players configurations.
`player.read`	Read-only access to Player configurations.
`player.write`	Allows updating existing Player configurations.
`playlist.create`	Allows creating new playlists and adding videos to them.
`playlist.delete`	Allows deleting playlists and removing videos from them.
`playlist.manage`	Full access to playlist management: creating, editing, and deleting playlists and managing their video items.
`playlist.read`	Read-only access to playlists and their video items.
`playlist.write`	Allows editing existing playlists and managing their video items.
`profile.create`	Allows creating profile data.
`profile.delete`	Allows deleting profile data.
`profile.manage`	Full access to user profile management: reading, updating, and deleting profile data.
`profile.read`	Read-only access to user profile information.
`profile.write`	Allows updating profile data.
`video.delete`	Allows deleting videos content, including subtitles and transcripts.
`video.manage`	Full access to video management: uploading, reading, editing, and deleting videos, along with subtitle, transcript, embed, and distribution management.
`video.read`	Read-only access to video content, including subtitles and transcripts.
`video.upload`	Allows uploading videos.
`video.write`	Allows editing existing videos, including subtitles and transcripts.