Put Tenant Branding | VMware Cloud Director OpenAPI

Put Tenant Branding

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

Request

URI

PUT

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

COPY

Path Parameters

string

org

Required

Organization for whom branding is being set

Request Body

UiBranding of type(s) application/json

Optional

Show optional properties

{
    "portalName": "string",
    "customLinks": [
        {
            "menuItemType": "string"
        }
    ]
}

{
    "portalName": "string",
    "portalColor": "string",
    "selectedTheme": {
        "themeType": "string",
        "name": "string"
    },
    "customLinks": [
        {
            "name": "string",
            "menuItemType": "string",
            "url": "string"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns UiBranding of type(s) application/json;version=39.1

"UiBranding Object"

string

portalName

Required

portalName

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.

object

selectedTheme

Optional

A theme supported by vCloud Director.

array of object

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.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"customLinks":["object"],"portalName:"string"}' https://{api_host}/cloudapi/branding/tenant/{org}

Deprecated

Availability

Added in 32.0

Deprecated in 37.1

With alternative: see

See /cloudapi/1.0.0/brandingThemes

On This Page

Description

Request

Path Parameters

Request Body

Authentication