[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

BrandingThemeResourceCustomLink

Custom link content of a branding theme’s resource. Can be defined as a link, override (well known links that can be overridden, Default values are About, Help, VMRC), section, separator(section without a name) of the drop down menu.


Properties

string
linkType Required

Type of the custom link.

  • OVERRIDE- Override existing/pre-built custom item (well known links that can be overridden, Default values are About, Help, VMRC)
  • LINK - Represent an custom link
  • SEPARATOR - Used as a visual separator between the links/sections
  • GROUP - Used as a group of links/sections. Use parentId to group children links.


string
name Required

The string used to display in the UI portal this custom link.


string
scope Required

Defines the place where the link should appear in the UI portal.

  • LOGIN - Custom link to be shown on the login screen
  • LOGOUT- Custom link to be shown on the logout screen
  • PORTAL- Custom link to be shown within the UI portal after authorization


string
id Optional

Id of the custom link. The Id is provided by the client in the CustomLinks file.


number
order Optional

Used to order the links during display in the UI portal. Links with the same order should be ordered by name


string
parentId Optional

Id of parent Custom link of type GROUP. Custom links that share a parentId will be grouped together. The Id is provided by the client in the CustomLinks file.


string
url Optional

The URL to be used in the UI portal to navigate user. To be used when linkType is either OVERRIDE or LINK, otherwise it will be ignored.

JSON Example

{
	"linkType": "string",
	"name": "string",
	"scope": "string"
}
[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 37.0.0-alpha
What's changed in v36.3?

INTRODUCED


Feedback

Was this page helpful?