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.
Operations
The currently supported operations options are shown in the following table:
| API | Operations | Studio Version |
|---|---|---|
| Analytics API | video-cloud/analytics/read |
 |
| Audience API | video-cloud/audience/readvideo-cloud/audience/write |
 |
| Cloud Playout APIs | video-cloud/cloud-playout/readvideo-cloud/cloud-playout/all |
 |
| CMS API [1-1] |
video-cloud/video/readvideo-cloud/video/createvideo-cloud/video/updatevideo-cloud/video/deletevideo-cloud/video/allvideo-cloud/asset/deletevideo-cloud/playlist/readvideo-cloud/playlist/createvideo-cloud/playlist/updatevideo-cloud/playlist/deletevideo-cloud/playlist/allvideo-cloud/sharing-relationships/readvideo-cloud/sharing-relationships/createvideo-cloud/sharing-relationships/updatevideo-cloud/sharing-relationships/deletevideo-cloud/sharing-relationships/allvideo-cloud/notifications/all
|
 |
| Cross Device Playback API | video-cloud/xdr/read
|
none |
| Dynamic Ingest API[1-1] | video-cloud/video/allvideo-cloud/ingest-profiles/profile/readvideo-cloud/ingest-profiles/account/readvideo-cloud/upload-urls/read |
 |
| Ingest Profiles API |
video-cloud/ingest-profiles/profile/readvideo-cloud/ingest-profiles/profile/writevideo-cloud/ingest-profiles/account/readvideo-cloud/ingest-profiles/account/write |
 |
| In-Page Experience API | video-cloud/experience/readvideo-cloud/experience/all |
 |
| Playback Auth Keys | video-cloud/playback-auth/key/readvideo-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/readvideo-cloud/playback-auth/playback-rights/write
|
None |
| Player Management API | video-cloud/player/readvideo-cloud/player/all |
 |
| Social API |
video-cloud/social/api/readvideo-cloud/social/mrss/readvideo-cloud/social/mrss/write
|
 |
| SSAI API |
video-cloud/ssai/readvideo-cloud/ssai/all
|
 |
| Live 2.0 API |
video-cloud/livev2/jobs/readvideo-cloud/livev2/jobs/createvideo-cloud/livev2/jobs/updatevideo-cloud/livev2/jobs/deletevideo-cloud/livev2/jobs/allvideo-cloud/livev2/metrics/read
|
 |
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.
| 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/allor 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/allor 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/allor 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 |
|
In-Page Experiences -> Read |
|
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 |
video-cloud/livev2/jobs/read |
Livev2 Jobs -> Read |
video-cloud/livev2/jobs/create |
Livev2 Jobs -> Create |
video-cloud/livev2/jobs/update |
Livev2 Jobs -> Update |
video-cloud/livev2/jobs/delete |
Livev2 Jobs -> Delete |
video-cloud/livev2/jobs/all |
Livev2 Jobs -> All | or
video-cloud/livev2/metrics/read |
Livev2 Metrics -> Read |
| API | Operations |
|---|---|
| Player Management API | perform/player/all |
Notes
- [1-1]
videopermissions include permissions for correspondingassetoperations - i.e./video/allgives you permissions for all asset operations (operations on the CMS API endpoints /accounts//videos//assets/...),/video/readgives you permissions for asset read operations, etc.
For detailed guides to getting client credentials using curl or Postman, see: