Create Branding Theme

Create a new custom theme, uniquely identified by name.

This can be used to set the theme in "/branding".

Request

URI

POST

https://{api_host}/cloudapi/branding/themes

COPY

Request Body

BrandingTheme of type(s) application/json

Optional

{
    "id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "themeType": "string",
    "isLegacy": false,
    "isDefault": false,
    "active": false,
    "themeBase": "string",
    "logoThumbprint": "string",
    "version": "string",
    "previewStyles": "string",
    "entityState": "string",
    "errorMessage": "string"
}

string

Optional

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

string

name

Required

Display name for the Branding 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

boolean

isLegacy

Optional

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

boolean

isDefault

Optional

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

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

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

logoThumbprint

Optional

base64 encoded Logo thumbprint generated from the provided logo resource.

string

version

Optional

Version of the theme

string

previewStyles

Optional

Subset of the provided custom resource styles.

string

entityState

Optional

State of the theme entity. Only themes which are RESOLVED can be used/assigned

PRE_CREATED - Theme is created but no theme assets are present
RESOLVED - Theme is ready to use and theme assets are present
RESOLUTION_ERROR - There is an issue with the theme configuration or the theme assets archive
IN_DELETION - When theme is being deleted, this is set as intermediate state

string

errorMessage

Optional

Error message (if any) associated with the theme entityState

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

201

Created

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

{
    "id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "themeType": "string",
    "isLegacy": false,
    "isDefault": false,
    "active": false,
    "themeBase": "string",
    "logoThumbprint": "string",
    "version": "string",
    "previewStyles": "string",
    "entityState": "string",
    "errorMessage": "string"
}

string

Optional

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

string

name

Required

Display name for the Branding 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

boolean

isLegacy

Optional

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

boolean

isDefault

Optional

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

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

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

logoThumbprint

Optional

base64 encoded Logo thumbprint generated from the provided logo resource.

string

version

Optional

Version of the theme

string

previewStyles

Optional

Subset of the provided custom resource styles.

string

entityState

Optional

State of the theme entity. Only themes which are RESOLVED can be used/assigned

PRE_CREATED - Theme is created but no theme assets are present
RESOLVED - Theme is ready to use and theme assets are present
RESOLUTION_ERROR - There is an issue with the theme configuration or the theme assets archive
IN_DELETION - When theme is being deleted, this is set as intermediate state

string

errorMessage

Optional

Error message (if any) associated with the theme entityState

Availability

Added in 30.0

Deprecated in 37.1

With alternative: see

See /cloudapi/1.0.0/brandingThemes

On This Page

Description

Request