API Operations for Client Credentials Requests

In this topic, you will learn about the operations (kind of like permissions) available from different APIs you may wish to use. You will need these operations when you make request to the OAuth service.

Overview

This document details the operations available from different APIs. You need these when you make requests to the OAuth Service for client credentials.

Note: for some APIs, client credentials can also be obtained using OAuth Credentials UI. See the following document for instructions on using the OAuth UI.

Managing API Authentication Credentials

Operations

The currently supported operations options are shown in the following table:

API Operations
API	Operations	Studio Version
Analytics API	`video-cloud/analytics/read`
Audience API	`video-cloud/audience/read` `video-cloud/audience/write`
Cloud Playout APIs	`video-cloud/cloud-playout/read` `video-cloud/cloud-playout/all`
CMS API [1-1]	`video-cloud/video/read` `video-cloud/video/create` `video-cloud/video/update` `video-cloud/video/delete` `video-cloud/video/all` `video-cloud/asset/delete` `video-cloud/playlist/read` `video-cloud/playlist/create` `video-cloud/playlist/update` `video-cloud/playlist/delete` `video-cloud/playlist/all` `video-cloud/sharing-relationships/read` `video-cloud/sharing-relationships/create` `video-cloud/sharing-relationships/update` `video-cloud/sharing-relationships/delete` `video-cloud/sharing-relationships/all` `video-cloud/notifications/all`
Cross Device Playback API	`video-cloud/xdr/read`	none
Dynamic Ingest API^[1-1]	`video-cloud/video/all` `video-cloud/ingest-profiles/profile/read` `video-cloud/ingest-profiles/account/read` `video-cloud/upload-urls/read`
Ingest Profiles API	`video-cloud/ingest-profiles/profile/read` `video-cloud/ingest-profiles/profile/write` `video-cloud/ingest-profiles/account/read` `video-cloud/ingest-profiles/account/write`
In-Page Experience API	`video-cloud/experience/read` `video-cloud/experience/all`
Playback Auth Keys	`video-cloud/playback-auth/key/read` `video-cloud/playback-auth/key/write`
Blacklist API	`video-cloud/playback-auth/blacklist`	None
Audit API	`video-cloud/playback-auth/audit`	None
Playback Rights API	`video-cloud/playback-auth/playback-rights/read` `video-cloud/playback-auth/playback-rights/write`	None
Player Management API	`video-cloud/player/read` `video-cloud/player/all`
Social API	`video-cloud/social/api/read` `video-cloud/social/mrss/read` `video-cloud/social/mrss/write`
SSAI API	`video-cloud/ssai/read` `video-cloud/ssai/all`

Operations and Studio equivalents

To simplify the selection of permissions for non-developers, the API Authentication user interface in Studio represents them differently than they are named in API operations:

The following table shows the API operations and their equivalents in the Studio API Authentication page.

Operations and Studio Equivalents
API Operation	Studio Equivalent
`video-cloud/analytics/read`	Analytics -> Read
`video-cloud/audience/read`	Audience -> Read
`video-cloud/audience/read` + `video-cloud/audience/write`	Audience -> Read/Write
`video-cloud/cloud-playout/read`	Cloud Playout -> Read
`video-cloud/cloud-playout/all`	Cloud Playout -> Read/Write
`video-cloud/video/read`	CMS -> Video Read
`video-cloud/video/create`	Dynamic Ingest -> Create
`video-cloud/video/all` or `video-cloud/video/read` + `video-cloud/video/create` + `video-cloud/video/update` + `video-cloud/video/delete`	CMS -> Video Read/Write
`video-cloud/playlist/read`	CMS -> Playlist Read
`video-cloud/playlist/all` or `video-cloud/playlist/read` + `video-cloud/playlist/create` + `video-cloud/playlist/update` + `video-cloud/playlist/delete`	CMS -> Playlist Read/Write
`video-cloud/asset/delete`	No equivalent
`video-cloud/sharing-relationships/read`	CMS -> Sharing Relationships Read
`video-cloud/sharing-relationships/all` or `video-cloud/sharing-relationships/read` + `video-cloud/sharing-relationships/create` + `video-cloud/sharing-relationships/update` + `video-cloud/sharing-relationships/delete`	CMS -> Sharing Relationships Read/Write
`video-cloud/notifications/all`	CMS -> Notifications
`video-cloud/upload-urls/read`	Dynamic Ingest -> Push Files
`video-cloud/experience/read`	In-Page Experiences -> Read
`video-cloud/experience/all`	In-Page Experiences -> Read/Write
`video-cloud/ingest-profiles/profile/read`	Ingest Profile -> Read
`video-cloud/ingest-profiles/profile/read` + `video-cloud/ingest-profiles/profile/write`	Ingest Profile -> Read/Write
`video-cloud/ingest-profiles/account/read`	Ingest Profile -> Configuration Read
`video-cloud/ingest-profiles/account/read` + `video-cloud/ingest-profiles/account/write`	Ingest Profile -> Configuration Read/Write
`video-cloud/player/read`	Players -> Read
`video-cloud/player/all`	Players -> Read/Write
`video-cloud/playback-auth/key/read`	Playback Auth Key -> Read
`video-cloud/playback-auth/key/write`	Playback Auth Key -> Write
`video-cloud/social/api/read`	Social -> Status Read
`video-cloud/social/mrss/read`	Social -> MRSS Read
`video-cloud/social/mrss/write`	Social -> MRSS Write
`video-cloud/ssai/read`	SSAI -> Read
`video-cloud/ssai/all`	SSAI -> Read/Write

API Operations
API	Operations
Player Management API	`perform/player/all`

Notes

^[1-1] video permissions include permissions for corresponding asset operations - i.e. /video/all gives you permissions for all asset operations (operations on the CMS API endpoints /accounts//videos//assets/...), /video/read gives you permissions for asset read operations, etc.

For detailed guides to getting client credentials using curl or Postman, see: