Create Branding Theme

Create Branding Theme

Creates a new branding theme

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/brandingThemes
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"
}
string
id
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.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns BrandingTheme of type(s) application/json;version=38.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"
}
string
id
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.


Availability
Added in 39.0.0-alpha
On This Page
Branding Theme Operations
POST
Convert Old Themes
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
PUT
Update Branding Theme
PUT
Upload Branding Resource