Get Active Theme Main Flavor

Get Active Theme Main Flavor

Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in its main flavor. To fetch each file, build a URL from filesRoot + files[i] and GET it. This resource is accessible without authentication.

Request
URI
GET
https://{api_host}/cloudapi/vcf/themes/active/{orgName}
COPY
Path Parameters
string
orgName
Required

Resolve the active theme of the organization with the given name. If there is no such organization, or it is not assigned a dedicated theme, the default theme will be returned.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ThemeDescriptor of type(s) application/json;version=40.0 
{
    "mainFlavor": "string",
    "portalName": "string",
    "filesRoot": "string",
    "files": {}
}
string
mainFlavor
Optional

The main flavor contains all mandatory assets. Requests for non-main flavors which are not defined, or do not contain a mandatory asset will have the result default to the main flavor.

string
portalName
Optional

The name of the portal.

string
filesRoot
Optional

The root of the relative links in files.

object
files
Optional

A map of resource kind(background, logo, etc) -> relative URL. Build absolute URLs by prefixing with the filesRoot and GET the actual contents of each file of the theme.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object],[object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/themes/active/{orgName}
Availability
Added in 41.0.0-alpha
On This Page
Branding Theme Operations
GET
Get Active Theme Main Flavor
GET
Get Active Theme
GET
Get Theme File
GET
Get Theme Flavor File