Get Branding Theme

Get Branding Theme

Gets an existing branding theme

Request
URI
GET
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

string
brandingThemeId
Required

branding theme URN or 'active' for the current organization active theme


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BrandingTheme of type(s) application/json;version=37.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.