Changed2
[{"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

Create Branding Theme

Description

Creates a new branding theme

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/brandingThemes
Copy

Request Body

Request Body

BrandingTheme of type(s) application/json Required
{
	"name": "string"
}
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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns BrandingTheme of type(s) application/json;version=37.0
{
	"active": false,
	"id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"isDefault": false,
	"isLegacy": false,
	"logoThumbprint": "string",
	"name": "string",
	"previewStyles": "string",
	"themeBase": "string",
	"themeType": "string",
	"version": "string"
}
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

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"active":false,"id":"urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","isDefault":false,"isLegacy":false,"logoThumbprint":"string","name":"string","previewStyles":"string","themeBase":"string","themeType":"string","version":"string"}' https://{api_host}/cloudapi/1.0.0/brandingThemes
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/brandingTheme/create


[{"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
What's changed in v37.0?
INTRODUCED
New in this version
Feedback

Was this page helpful?