Update Branding Theme

Updates existing branding theme

Request

URI

PUT

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

COPY

Path Parameters

string

brandingThemeId

Required

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

Request Body

BrandingTheme of type(s) application/json

Optional

Show optional properties

{
    "name": "string"
}

{
    "id": "urn:vcloud:entity:vmware:brandinguitheme:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "themeType": "string",
    "isDefault": false,
    "themeBase": "string",
    "mainFlavor": "string",
    "logoThumbprint": "string",
    "version": "string",
    "previewStyles": "string",
    "entityState": "string",
    "errorMessage": "string",
    "contentDescriptor": {
        "favIcon": "example.ico",
        "logo": "example.png",
        "background": "example.png",
        "styles": "example.css",
        "portalName": "VCF Automation",
        "localizations": "example.json",
        "customLinks": "example.json",
        "idpLoginButtons": "idpLoginButtons.json"
    }
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

"BrandingTheme Object"

string

Optional

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

string As ^[ \w.-]+$

name

Required

Constraints: minLength: 1 maxLength: 128

Display name for the Branding Theme

string As ^(CUSTOM|BUILT_IN)$

themeType

Optional

Constraints: default: CUSTOM

Type of the Branding Theme. Supported theme types are:

BUILT_IN - Theme pre-bundled with VCF Automation
CUSTOM - Custom Branding Theme

boolean

isDefault

Optional

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

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 As ^[\w-]+$

mainFlavor

Optional

Constraints: default: light

This indicates the main flavor of the theme. The main flavor is mandatory and its resource folder must contain all mandatory assets.

string

logoThumbprint

Optional

base64 encoded Logo thumbprint generated from the provided logo resource.

string

version

Optional

Constraints: default: 1.0.0

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

contentDescriptor

Optional

Describes the last successfully uploaded assets of the theme.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/cloudapi/vcf/brandingThemes/{brandingThemeId}

Availability

Added in 41.0.0-alpha

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Branding Theme Operations

GET