[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"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

Put Tenant Branding

Description

Sets the branding information including the portal name, portal color, selected theme and custom URLs for a specific org.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/branding/tenant/{org}
Copy

Path Parameters

Path Parameters

string
org Required

Organization for whom branding is being set


Request Body

Request Body

UiBranding of type(s) application/json Required
{
	"customLinks": [
		{
			"menuItemType": "link"
		}
	],
	"portalName": "string"
}
customLinks Required

An ordered list of menu items which can be customized and used in the application. 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.


string
portalName Required

string
portalColor Optional

A custom color defined by the administrator and used to theme the site. The color should be in rgb hex color format such as “FFFFFF” all capitalized. Can be set to an empty string to use the selected theme’s default colors.


selectedTheme Optional

A theme supported by vCloud Director.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UiBranding of type(s) application/json;version=37.0
{
	"customLinks": [
		{
			"menuItemType": "link",
			"name": "string",
			"url": "string"
		}
	],
	"portalColor": "string",
	"portalName": "string",
	"selectedTheme": {
		"name": "string",
		"themeType": "string"
	}
}
customLinks Required

An ordered list of menu items which can be customized and used in the application. 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.


string
portalName Required

string
portalColor Optional

A custom color defined by the administrator and used to theme the site. The color should be in rgb hex color format such as “FFFFFF” all capitalized. Can be set to an empty string to use the selected theme’s default colors.


selectedTheme Optional

A theme supported by vCloud Director.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"customLinks":[{"menuItemType":"link","name":"string","url":"string"}],"portalColor":"string","portalName":"string","selectedTheme":{"name":"string","themeType":"string"}}' https://{api_host}/cloudapi/branding/tenant/{org}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"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
Feedback

Was this page helpful?