API - Custom User Tabs

Support Center > API Integration

Published 07/19/2019 at 10:46pm UTC

Page viewed 83 times

Details

How can I programmatically define custom tabs that should be shown to an individual user?

Answer

Custom User Tabs API

Every account has the ability to define and display custom tabs in the SecureVideo user interface as part of their branding (click here for more details).

API customers have the ability to override their account-wide custom tab definition and display custom tabs that are specific to each user.

To do this, there are 3 API methods available in the Custom User Tabs API:

 

Get Custom User Tabs

GET https://api.securevideo.com/usertabs/5 (where 5 is the SecureVideo.com User ID)

Gets the current Custom User Tab definition for the user, for an example and explanation see the below section Set Custom User Tabs. If the user has no Custom User Tab configured, returns HTTP 204 (No Content).

 

Set Custom User Tabs

PUT https://api.securevideo.com/usertabs/5 (where 5 is the SecureVideo.com User ID)

{
 "CustomTabs": 
 [
  {
   "TabText": "My Site Link 1",
   "IsInline": true,
   "LinkUrl": "https://yoursite.com/link1",
   "OpenInNewWindow": false
  },
  {
   "TabText": "My Site Link 2",
   "IsInline": true,
   "LinkUrl": "https://yoursite.com/link2",
   "OpenInNewWindow": false
  }
 ],
 "HomeLink":
 {
  "LinkUrl": "https://yoursite.com/homepage",
  "OpenInNewWindow": true
 }
}

The CustomTabs array is optional, and defines the custom tabs that this user should see. Tabs will be displayed left to right, in the order that you place the array elements. If CustomTabs is omitted, then no custom tabs will be shown for the user except those defined on your Branding screen. If CustomTabs is omitted and no custom tabs are defined on your account-wide Branding screen, then no custom tabs will be shown.

The HomeLink property is optional, and defines the link URL for your customer logo which appears in the upper-left hand corner of the SecureVideo user interface. If HomeLink is omitted, then the link will behave according to the account-wide definition set up on your Branding screen.

The properties for the CustomTabs and (the subset of those in) HomeLink objects are as follows:

TabText is required and indicates the text to be displayed in the tab.

IsInline is optional and indicates whether the tab should be shown in the line of and to the left of the top row SecureVideo navigation elements (true), or above the top row SecureVideo navigation elements (false). If omitted, the default is false.

LinkUrl is required and indicates the URL the user should navigate to when the link is clicked.

OpenInNewWindow is optional and indicates whether the link, when clicked, should open in a new browser window/tab. If omitted, the default is false.

On success, this request will return a 200 Status Code, along with the updated CustomUserTabs object that was saved to the User profile. This could differ from the JSON you PUT into the API, in the event that you included any additional unused properties or decided not to include any optional properties.

 

Delete Custom User Tabs

DELETE https://api.securevideo.com/usertabs/5 (where 5 is the SecureVideo.com User ID)

Removes the Custom User Tab definition for the user; the user will henceforth see the default tabs for the account. On success returns HTTP 204 (No Content).

 

This article was last reviewed by our Support team on July 19, 2019.