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

string

org

Required

Organization for whom branding is being set

Request Body

UiBranding of type(s) application/json

Optional

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

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.

UiTheme

selectedTheme

Optional

selectedTheme

array of UiBrandingMenuItem

customLinks

Required

customLinks

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

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

string

portalName

Required

portalName

string

portalColor

Optional

UiTheme

selectedTheme

Optional

selectedTheme

array of UiBrandingMenuItem