Rev User-Level API Key

Home
Change Log
Authentication
- OAuth Login
  - Get Authorization
  - Post Access Token Request
- Post User API Key Login
- Post Extend API Key Session
- Delete Revoke API Key Session
- Post Username Login
- Post Extend Username Session
- Post Username Logoff
User Accounts
- Post Create a User
- Delete Delete a User
- Post Upload a Profile Image
- Delete Delete a Profile Image
- Get List All Roles
- Get User Session
- Patch Patch User Data
User Search
- Get Search Access Entity
- Get Search By UserID
- Get Search By Username
- Get Search By Email
- Get List Users in a Group
Video
- Post Upload a Video
- Post Link a Video
- Get Get Video Details
- Get Get Video Status
- Get Get Playback URL
- Get Download a Video
- Put Edit Video Metadata
- Patch Patch Video Metadata
- Put Migrate a Video
- Put Edit Video Access Control
- Put Replace a Video
- Put Transcode a Video
- Delete Delete a Video
- Video Conference Recording
- Post Supplemental Files & Thumbnails
- Chapters
- Comments & Ratings
- Get Search Video
- Approval Processes
- Post Transcription & Translation
- Post Tag Users
- Get Get Tag Users Status
- Get oEmbed
Channels
- Post Create a Channel
- Put Edit a Channel
- Delete Delete a Channel
- Get List Channels
- Get List a User’s Channels
Webcasts
- Post Create a Webcast
- Put Edit a Webcast
- Put Edit Webcast Access Control
- Put Upload Webcast Branding
- Patch Patch Webcast Data
- Control a Webcast
- Link a Webcast
- Delete Delete a Webcast
- Delete Webcasts (in Bulk)
- Get Bulk Webcast Delete Status
- Get Get Webcast Details
- Post Webcast Files
- Webcast Registration Fields
- Webcast Q&A Management
Zones
- Post Create a Zone
- Put Edit a Zone
- Get List Zones
- Get List Zone Devices
- Delete Delete a Zone
DME Management
Presentation Profiles
Playlists
- Playlist Management
- Put Featured Playlist
Analytics
- Get Video Report
- Get Webcast Reports
- Get User Reports
- Get Rev IQ Credits Usage
Administrative
- Get Account Branding
- Get System Health
- Get Maintenance Schedule
- Category Management
- Group Management
- Custom Fields
Audit
- Get Audit Videos
- Get Audit Users
- Get Audit Groups
- Get Audit Events
- Get Audit Devices
- Get Audit Principal (User)

Rev User-Level API Key Authentication

This authentication API endpoint is used to authenticate individual user using user’s pre-generated API Key and Secret. Use the token that is returned in the response as the Authorization to run other public APIs. Once a session is established using this endpoint, subsequent API calls that uses the token returned from this endpoint will be limited according to the role and privileges of this particular user. Using this method, the user via API will have the same privileges and roles that user has when they login to Rev UI. This authentication mechanism can be used to automate Rev workflows using role and privileges of a given user.

Account Admins can generate user’s API Key and Secret combination. Secret is only visible at the time of generation. API Key and Secret combination can be regenerated and deleted. The key will not work for suspended users. Also authenticating a user using this method will consume a user license if the user is unlicensed.

POST

/api/v2/authenticate

Request Body

Example

Example

application/json

{"ApiKey":"3432lkjdfasdf7897asdfmyapikeyhere","Secret":"asfasdfe8342242342mysecrethere"}

Response Messages

200

Successful response

"token": "0SoxSd50t5V-Or6MpWMGa6Al8dKzCRhyqKCxi7PsDJwmbN4-PQb86IXTtS-zQc5s6Mx3Orz5eGdtQqn1r7cTuakEBGsnI_ETHmjDPYk2fkbPVhYcs5OzTEMhhR_3vnlHgyht_Af-fEBnQ4XBgLhFtbBIfgRrI_BemY-vRKG9Qyqn6Iwake74PwxBsGGETd77FNmmos86vTO8V35HuUTYVAiCCGPLDKS966gZhDsQqIY1", "issuer": "VBrick", "expiration": "2020-07-14T20:34:13.881Z"

401

Unauthorized error

500

Internal server error

search check