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

Update Branding Theme

Description

Updates existing branding theme

Request

URL

put

https://{api_host}/cloudapi/1.0.0/brandingThemes/{brandingThemeId}

Copy

Path Parameters

string

brandingThemeId Required

branding theme URN or ‘active’ for the current organization active theme

Request Body

BrandingTheme of type(s) application/json Required

Show optional properties

{}

{
    "id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

string

name Required

Display name for the Branding Theme

boolean

active Optional

If true, the branding theme is used for branding customization of the organization. Only one branding theme can be active for organization.

string

id Optional

A unique identifier for the branding theme (read-only).

boolean

isDefault Optional

If true, the branding theme is used by any organization with no explicit theme assignment.

boolean

isLegacy Optional

If true, the branding theme is represented in old format that can not be edited.

string

logoThumbprint Optional

base64 encoded Logo thumbprint generated from the provided logo resource.

string

previewStyles Optional

Subset of the provided custom resource styles.

string

themeBase Optional

This indicates whether the theme css is based of the light or dark css base. Missing value indicates the base is unknown. Enum options - CLARITY_LIGHT_THEME, CLARITY_DARK_THEME.

string

themeType Optional

Type of the Branding Theme. Supported theme types are:

BUILT_IN - Theme pre-bundled with Cloud Director
CUSTOM - Custom Branding Theme

string

version Optional

Version of the theme

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns BrandingTheme of type(s) application/json;version=37.1

{
    "id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

string

name Required

Display name for the Branding Theme

boolean

active Optional

If true, the branding theme is used for branding customization of the organization. Only one branding theme can be active for organization.

string

id Optional

A unique identifier for the branding theme (read-only).

boolean

isDefault Optional

If true, the branding theme is used by any organization with no explicit theme assignment.

boolean

isLegacy Optional

If true, the branding theme is represented in old format that can not be edited.

string

logoThumbprint Optional

base64 encoded Logo thumbprint generated from the provided logo resource.

string

previewStyles Optional

Subset of the provided custom resource styles.

string

themeBase Optional

This indicates whether the theme css is based of the light or dark css base. Missing value indicates the base is unknown. Enum options - CLARITY_LIGHT_THEME, CLARITY_DARK_THEME.

string

themeType Optional

Type of the Branding Theme. Supported theme types are:

BUILT_IN - Theme pre-bundled with Cloud Director
CUSTOM - Custom Branding Theme

string

version Optional

Version of the theme

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"id":"urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}' https://{api_host}/cloudapi/1.0.0/brandingThemes/{brandingThemeId}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-event: com/vmware/vcloud/event/brandingTheme/modify

vmware-cloud-director

Availability

Added in 38.0.0-alpha

Branding Theme Operations

post

Convert Old Themes Introduced

post

Create Branding Theme

post

Create Branding Theme Assignment

put

Create Branding Theme Assignments

delete

Delete Branding Theme

delete

Delete Branding Theme Assignment

get

Get Active Background Theme Resource

get

Get Active Css Theme Resource

get

Get Active Custom Links Theme Resource

get

Get Active Fav Icon Theme Resource

get

Get Active Logo Theme Resource

get

Get Active Portal Name Theme Resource

get

Get Branding Theme

get

Get Branding Theme Assignments

get

Get Branding Themes

get

Get Branding Themes Assignments

get

Get Theme Zip Introduced

put

Update Branding Theme

put

Upload Branding Resource

Update Branding Theme

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

Availability

On This Page

Branding Theme Operations

Was this page helpful?