1 of 5

Themes

Footer URL

Group Filter

Image

Custom Images

Group Filter

Get

Retrieve the group filters from the Theme

GET/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID.

Response

Success

Body

namenullable string

The group name

sidnullable string

The group SID

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "sid": "text"
  }
]

Add

Add the specified group filter to the Theme.

POST/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID

Body

Theme

groupNamenullable string

The name of the group list

groupSIDnullable string

The group SID

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Remove the specified group filter from the Theme

DELETE/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID

Body

Theme

groupNamenullable string

The name of the group list

groupSIDnullable string

The group SID

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Themes

List

Retrieve information about a list of Themes.

GET/api/Theme

Query parameters

Namestring

Filter the result by Theme name (optional)

SiteIdinteger (int32)

Site ID for which to retrieve Theme(s) (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

const response = await fetch('/api/Theme', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:12:27.032Z",
    "timeLastMod": "2024-11-07T10:12:27.032Z",
    "name": "text",
    "description": "text",
    "enabled": false,
    "overrideAuthenticationDomain": false,
    "domain": "text",
    "groupEnabled": false,
    "groupFilters": [
      {
        "name": "text",
        "sid": "text"
      }
    ],
    "postLogonMessage": "text",
    "userPortal": {
      "url": {
        "loginPageURLPath": "text",
        "showDownloadURL": false,
        "overrideWindowsClientDownloadURL": "text",
        "footerURLs": [
          {
            "url": "text",
            "text": "text",
            "tooltip": "text"
          }
        ]
      },
      "branding": {
        "webpageTitle": "text",
        "loginTo": "text"
      },
      "color": {
        "headerOptions": [
          "0 = Blurred",
          "1 = SolidColor"
        ],
        "workAreaImage": [
          "0 = SolidColor",
          "1 = Image1",
          "2 = Image2",
          "3 = Image3",
          "4 = Image4",
          "5 = Image5"
        ]
      },
      "languageBar": {
        "default": [
          "0 = Default",
          "1 = English",
          "2 = German",
          "3 = Japanese",
          "5 = French",
          "6 = Spanish",
          "7 = Italian",
          "8 = Portuguese",
          "9 = ChineseSimplified",
          "10 = ChineseTraditional",
          "11 = Korean",
          "12 = Dutch"
        ],
        "de_DE": false,
        "en_US": false,
        "es_ES": false,
        "fr_FR": false,
        "it_IT": false,
        "ja_JP": false,
        "ko_KR": false,
        "nl_NL": false,
        "pt_BR": false,
        "zh_CN": false,
        "zh_TW": false
      },
      "message": {
        "preLogonMessage": "text",
        "overridePostLogonMessage": false,
        "userPortalPostLogonMessage": "text"
      },
      "inputPrompt": {
        "de_DE": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "en_US": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "es_ES": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "fr_FR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "it_IT": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "ja_JP": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "ko_KR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "nl_NL": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "pt_BR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "zh_CN": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "zh_TW": {
          "loginHint": "text",
          "passwordHint": "text"
        }
      },
      "gateway": {
        "overrideGatewaySettings": false,
        "launchMethod": [
          "0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
          "1 = Launch_Applications_with_Parallels_Client",
          "2 = Launch_Applications_with_Browser_HTML5"
        ],
        "allowLaunchMethod": false,
        "allowAppsInNewTab": false,
        "pre2000Cred": false,
        "allowEmbed": false,
        "fileTransferMode": [
          "0 = Disabled",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ],
        "clipboardDirection": [
          "0 = None",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ],
        "allowCORS": false,
        "allowedDomainsForCORS": [
          "text"
        ]
      },
      "legalPolicies": {
        "allowCookieConsent": false,
        "allowEULA": false
      }
    },
    "windowsClient": {
      "branding": {
        "companyName": "text",
        "applicationName": "text"
      },
      "messages": {
        "windowsClientOverridePostLogonMessage": false,
        "windowsClientPostLogonMessage": "text"
      },
      "customMenu": {
        "menuItem": "text",
        "command": "text"
      }
    }
  }
]

Create

Add a new Theme to a site.

POST/api/Theme

Body

Theme

name*nullable string

Name of the new Theme policy.

descriptionnullable string

Description for the new Theme policy.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

const response = await fetch('/api/Theme', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:12:27.032Z",
  "timeLastMod": "2024-11-07T10:12:27.032Z",
  "name": "text",
  "description": "text",
  "enabled": false,
  "overrideAuthenticationDomain": false,
  "domain": "text",
  "groupEnabled": false,
  "groupFilters": [
    {
      "name": "text",
      "sid": "text"
    }
  ],
  "postLogonMessage": "text",
  "userPortal": {
    "url": {
      "loginPageURLPath": "text",
      "showDownloadURL": false,
      "overrideWindowsClientDownloadURL": "text",
      "footerURLs": [
        {
          "url": "text",
          "text": "text",
          "tooltip": "text"
        }
      ]
    },
    "branding": {
      "webpageTitle": "text",
      "loginTo": "text"
    },
    "color": {
      "headerOptions": [
        "0 = Blurred",
        "1 = SolidColor"
      ],
      "workAreaImage": [
        "0 = SolidColor",
        "1 = Image1",
        "2 = Image2",
        "3 = Image3",
        "4 = Image4",
        "5 = Image5"
      ]
    },
    "languageBar": {
      "default": [
        "0 = Default",
        "1 = English",
        "2 = German",
        "3 = Japanese",
        "5 = French",
        "6 = Spanish",
        "7 = Italian",
        "8 = Portuguese",
        "9 = ChineseSimplified",
        "10 = ChineseTraditional",
        "11 = Korean",
        "12 = Dutch"
      ],
      "de_DE": false,
      "en_US": false,
      "es_ES": false,
      "fr_FR": false,
      "it_IT": false,
      "ja_JP": false,
      "ko_KR": false,
      "nl_NL": false,
      "pt_BR": false,
      "zh_CN": false,
      "zh_TW": false
    },
    "message": {
      "preLogonMessage": "text",
      "overridePostLogonMessage": false,
      "userPortalPostLogonMessage": "text"
    },
    "inputPrompt": {
      "de_DE": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "en_US": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "es_ES": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "fr_FR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "it_IT": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ja_JP": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ko_KR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "nl_NL": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "pt_BR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_CN": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_TW": {
        "loginHint": "text",
        "passwordHint": "text"
      }
    },
    "gateway": {
      "overrideGatewaySettings": false,
      "launchMethod": [
        "0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
        "1 = Launch_Applications_with_Parallels_Client",
        "2 = Launch_Applications_with_Browser_HTML5"
      ],
      "allowLaunchMethod": false,
      "allowAppsInNewTab": false,
      "pre2000Cred": false,
      "allowEmbed": false,
      "fileTransferMode": [
        "0 = Disabled",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "clipboardDirection": [
        "0 = None",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "allowCORS": false,
      "allowedDomainsForCORS": [
        "text"
      ]
    },
    "legalPolicies": {
      "allowCookieConsent": false,
      "allowEULA": false
    }
  },
  "windowsClient": {
    "branding": {
      "companyName": "text",
      "applicationName": "text"
    },
    "messages": {
      "windowsClientOverridePostLogonMessage": false,
      "windowsClientPostLogonMessage": "text"
    },
    "customMenu": {
      "menuItem": "text",
      "command": "text"
    }
  }
}

Get

Retrieve a specific Theme by ID.

GET/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

Response

Update

Modify settings of a Theme. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Body

Theme

namenullable string

General: The new name of the specified Theme

descriptionnullable string

General: Description of the Theme

enablednullable boolean

General: Whether Theme is enabled or not

mfaIdnullable integer (int32)

General: The MFA Provider Id. One can set MFAId as 0 to unassign MFA from a theme.

overrideAuthenticationDomainnullable boolean

General: Whether to override the authentication domain

domainnullable string

General: The domain used

groupEnablednullable boolean

General: Whether to limit Themes to a certain group

postLogonMessagenullable string

Messages: The post-logon message

loginPageURLPathnullable string

User Portal - URLs: The Theme login page URL Path following protocol and domain such as 'https://FQDN/path'.

showDownloadURLnullable boolean

User Portal - URLs: Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

User Portal - URLs: The Override download URL for branded Parallels Client (Windows)

webpageTitlenullable string

User Portal - Branding: The Webpage Title

loginTonullable string

User Portal - Branding: Change the Login To message in the User Portal login screen. The message can consist of any text and may include RAS variables: %FARM%, %SITE% or %THEME%.

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColornullable integer (int32)

User Portal - Colors: The header background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

workAreaBackgroundColornullable integer (int32)

User Portal - Colors: The work area background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

workAreaTextColornullable integer (int32)

User Portal - Colors: The work area text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

buttonsBackgroundColornullable integer (int32)

User Portal - Colors: The buttons background and link color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

buttonsTextColornullable integer (int32)

User Portal - Colors: The buttons text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

languageBar_DefaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

languageBar_de_DEnullable boolean

User Portal - Language bar: Whether to enable the German Language Bar or not

languageBar_en_USnullable boolean

User Portal - Language bar: Whether to enable the English (US) Language Bar or not

languageBar_es_ESnullable boolean

User Portal - Language bar: Whether to enable the Spanish Language Bar or not

languageBar_fr_FRnullable boolean

User Portal - Language bar: Whether to enable the French Language Bar or not

languageBar_it_ITnullable boolean

User Portal - Language bar: Whether to enable the Italian Language Bar or not

languageBar_ja_JPnullable boolean

User Portal - Language bar: Whether to enable the Japanese Language Bar or not

languageBar_ko_KRnullable boolean

User Portal - Language bar: Whether to enable the Korean Language Bar or not

languageBar_nl_NLnullable boolean

User Portal - Language bar: Whether to enable the Dutch Language Bar or not

languageBar_pt_BRnullable boolean

User Portal - Language bar: Whether to enable the Portuguese Language Bar or not

languageBar_zh_CNnullable boolean

User Portal - Language bar: Whether to enable the Chinese Simplified Language Bar or not

languageBar_zh_TWnullable boolean

User Portal - Language bar: Whether to enable the Chinese Traditional Language Bar or not

preLogonMessagenullable string

User Portal - Messages: The Pre-Logon message

userPortalPostLogonMessagenullable string

User Portal - Messages: The Post-Logon message

overridePostLogonMessagenullable boolean

User Portal - Messages: Whether to override the post-logon message

loginHint_de_DEnullable string

User Portal - Input prompt: The User Prompt: German

passwordHint_de_DEnullable string

User Portal - Input prompt: The Password Prompt: German

loginHint_en_USnullable string

User Portal - Input prompt: The User Prompt: English (US)

passwordHint_en_USnullable string

User Portal - Input prompt: The Password Prompt: English (US)

loginHint_es_ESnullable string

User Portal - Input prompt: The User Prompt: Spanish

passwordHint_es_ESnullable string

User Portal - Input prompt: The Password Prompt: Spanish

loginHint_fr_FRnullable string

User Portal - Input prompt: The User Prompt: French

passwordHint_fr_FRnullable string

User Portal - Input prompt: The Password Prompt: French

loginHint_it_ITnullable string

User Portal - Input prompt: The User Prompt: Italian

passwordHint_it_ITnullable string

User Portal - Input prompt: The Password Prompt: Italian

loginHint_ja_JPnullable string

User Portal - Input prompt: The User Prompt: Japanese

passwordHint_ja_JPnullable string

User Portal - Input prompt: The Password Prompt: Japanese

loginHint_ko_KRnullable string

User Portal - Input prompt: The User Prompt: Korean

passwordHint_ko_KRnullable string

User Portal - Input prompt: The Password Prompt: Korean

loginHint_nl_NLnullable string

User Portal - Input prompt: The User Prompt: Dutch

passwordHint_nl_NLnullable string

User Portal - Input prompt: The Password Prompt: Dutch

loginHint_pt_BRnullable string

User Portal - Input prompt: The User Prompt: Portuguese

passwordHint_pt_BRnullable string

User Portal - Input prompt: The Password Prompt: Portuguese

loginHint_zh_CNnullable string

User Portal - Input prompt: The User Prompt: Chinese Simplified

passwordHint_zh_CNnullable string

User Portal - Input prompt: The Password Prompt: Chinese Simplified

loginHint_zh_TWnullable string

User Portal - Input prompt: The User Prompt: Chinese Traditional

passwordHint_zh_TWnullable string

User Portal - Input prompt: The Password Prompt: Chinese Traditional

overrideGatewaySettingsnullable boolean

User Portal - Gateway: Whether to override the gateway settings for the Theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodnullable boolean

User Portal - Gateway: Whether to allow the user to launch session using a particular method

allowAppsInNewTabnullable boolean

User Portal - Gateway: Whether to allow applications in a new tab

pre2000Crednullable boolean

User Portal - Gateway: Whether to use the pre windows 2000 format

allowEmbednullable boolean

User Portal - Gateway: Whether to allow embed

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSnullable boolean

User Portal - Gateway: Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

User Portal - Gateway: Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsnullable integer (int32)

User Portal - Gateway: How long should the browser preserve the cache (in months).

allowCookieConsentnullable boolean

User Portal - Legal policies: Whether to allow cookies or not

allowEULAnullable boolean

User Portal - Legal policies: Whether to allow EULA

companyNamenullable string

Windows client - Branding: The Company Name

applicationNamenullable string

Windows client - Branding: The Application Name

progressBarColornullable integer (int32)

Windows client - Branding: The progress bar color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

windowsClientOverridePostLogonMessagenullable boolean

Windows client - Messages: Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

Windows client - Messages: The post-logon message

menuItemnullable string

Windows client - Custom menu: The Menu Item

commandnullable string

Windows client - Custom menu: The Command

Response

No Content

Request

Response

Delete

Delete a Theme from a site.

DELETE/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Response

No Content

Request

Response

Image

Get

Retrieve the image(s) of the Theme specified by ID. If more than 1 image is requested, a compressed .zip file is returned containing all the images.

GET/api/Theme/{id}/Image

Path parameters

id*integer (int32)

Theme ID.

Query parameters

ImageTypeThemeImageTypes (enum)

Theme Image Types.

1 = CompanyLogo,2 = FaviconIcon,4 = ConnectionBanner,8 = ApplicationIcon,15 = All

Response

Success

Request

const response = await fetch('/api/Theme/{id}/Image', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Update

Update an Image with specified ImageType of the Theme specified by ID.

PUT/api/Theme/{id}/Image

Path parameters

id*integer (int32)

Theme ID.

Query parameters

ImageTypeThemeImageType (enum)

Theme Image Type.

1 = CompanyLogo,2 = FaviconIcon,4 = ConnectionBanner,8 = ApplicationIcon

Resetboolean

Whether to reset the image file type specified or not. By default, it is set to false.

Body

ImageFilestring (binary)

Upload File

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/Image', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve the footer URLs from the Theme.

GET/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID.

Response

Success

Body

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "url": "text",
    "text": "text",
    "tooltip": "text"
  }
]

Add

Add the specified footer URL to the Theme.

POST/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID

Body

Theme

url*nullable string

The URL

text*nullable string

The text

tooltipnullable string

The tooltip

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "text": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Remove the specified footer URL from the Theme.

DELETE/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID

Body

Theme

url*nullable string

The URL

text*nullable string

The text

tooltipnullable string

The tooltip

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "text": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Custom Images

List

Retrieve theme custom images.

GET/api/Theme/CustomImage

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the theme custom images. If the parameter is omitted, the site ID of the Licensing Server will be used.

Response

Request

const response = await fetch('/api/Theme/CustomImage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Update

Modify a theme custom image.

PUT/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The ID of the Theme Custom Image to modify.

Body

Theme Custom Image

newName*nullable string

The new name of the specified Theme Custom Image

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "newName": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Add

Update an Image with specified ImageType of the Theme specified by ID.

POST/api/Theme/CustomImage

Query parameters

SiteIdinteger (int32)

Site ID in which to create the theme custom image. If the parameter is omitted, the site ID of the Licensing Server will be used.

Body

ImageFilestring (binary)

Upload File

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve a theme custom image.

GET/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The theme custom image ID.

Response

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a theme custom image.

DELETE/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The ID of the Theme Custom Image to remove.

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a Theme from a site.

DELETE/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Response

No Content

Request

Response

Update

Modify settings of a Theme. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Body

Theme

namenullable string

General: The new name of the specified Theme

descriptionnullable string

General: Description of the Theme

enablednullable boolean

General: Whether Theme is enabled or not

mfaIdnullable integer (int32)

General: The MFA Provider Id. One can set MFAId as 0 to unassign MFA from a theme.

overrideAuthenticationDomainnullable boolean

General: Whether to override the authentication domain

domainnullable string

General: The domain used

groupEnablednullable boolean

General: Whether to limit Themes to a certain group

postLogonMessagenullable string

Messages: The post-logon message

loginPageURLPathnullable string

User Portal - URLs: The Theme login page URL Path following protocol and domain such as 'https://FQDN/path'.

showDownloadURLnullable boolean

User Portal - URLs: Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

User Portal - URLs: The Override download URL for branded Parallels Client (Windows)

webpageTitlenullable string

User Portal - Branding: The Webpage Title

loginTonullable string

User Portal - Branding: Change the Login To message in the User Portal login screen. The message can consist of any text and may include RAS variables: %FARM%, %SITE% or %THEME%.

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColornullable integer (int32)

User Portal - Colors: The header background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

workAreaBackgroundColornullable integer (int32)

User Portal - Colors: The work area background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

workAreaTextColornullable integer (int32)

User Portal - Colors: The work area text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

buttonsBackgroundColornullable integer (int32)

User Portal - Colors: The buttons background and link color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

buttonsTextColornullable integer (int32)

User Portal - Colors: The buttons text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

languageBar_DefaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

languageBar_de_DEnullable boolean

User Portal - Language bar: Whether to enable the German Language Bar or not

languageBar_en_USnullable boolean

User Portal - Language bar: Whether to enable the English (US) Language Bar or not

languageBar_es_ESnullable boolean

User Portal - Language bar: Whether to enable the Spanish Language Bar or not

languageBar_fr_FRnullable boolean

User Portal - Language bar: Whether to enable the French Language Bar or not

languageBar_it_ITnullable boolean

User Portal - Language bar: Whether to enable the Italian Language Bar or not

languageBar_ja_JPnullable boolean

User Portal - Language bar: Whether to enable the Japanese Language Bar or not

languageBar_ko_KRnullable boolean

User Portal - Language bar: Whether to enable the Korean Language Bar or not

languageBar_nl_NLnullable boolean

User Portal - Language bar: Whether to enable the Dutch Language Bar or not

languageBar_pt_BRnullable boolean

User Portal - Language bar: Whether to enable the Portuguese Language Bar or not

languageBar_zh_CNnullable boolean

User Portal - Language bar: Whether to enable the Chinese Simplified Language Bar or not

languageBar_zh_TWnullable boolean

User Portal - Language bar: Whether to enable the Chinese Traditional Language Bar or not

preLogonMessagenullable string

User Portal - Messages: The Pre-Logon message

userPortalPostLogonMessagenullable string

User Portal - Messages: The Post-Logon message

overridePostLogonMessagenullable boolean

User Portal - Messages: Whether to override the post-logon message

loginHint_de_DEnullable string

User Portal - Input prompt: The User Prompt: German

passwordHint_de_DEnullable string

User Portal - Input prompt: The Password Prompt: German

loginHint_en_USnullable string

User Portal - Input prompt: The User Prompt: English (US)

passwordHint_en_USnullable string

User Portal - Input prompt: The Password Prompt: English (US)

loginHint_es_ESnullable string

User Portal - Input prompt: The User Prompt: Spanish

passwordHint_es_ESnullable string

User Portal - Input prompt: The Password Prompt: Spanish

loginHint_fr_FRnullable string

User Portal - Input prompt: The User Prompt: French

passwordHint_fr_FRnullable string

User Portal - Input prompt: The Password Prompt: French

loginHint_it_ITnullable string

User Portal - Input prompt: The User Prompt: Italian

passwordHint_it_ITnullable string

User Portal - Input prompt: The Password Prompt: Italian

loginHint_ja_JPnullable string

User Portal - Input prompt: The User Prompt: Japanese

passwordHint_ja_JPnullable string

User Portal - Input prompt: The Password Prompt: Japanese

loginHint_ko_KRnullable string

User Portal - Input prompt: The User Prompt: Korean

passwordHint_ko_KRnullable string

User Portal - Input prompt: The Password Prompt: Korean

loginHint_nl_NLnullable string

User Portal - Input prompt: The User Prompt: Dutch

passwordHint_nl_NLnullable string

User Portal - Input prompt: The Password Prompt: Dutch

loginHint_pt_BRnullable string

User Portal - Input prompt: The User Prompt: Portuguese

passwordHint_pt_BRnullable string

User Portal - Input prompt: The Password Prompt: Portuguese

loginHint_zh_CNnullable string

User Portal - Input prompt: The User Prompt: Chinese Simplified

passwordHint_zh_CNnullable string

User Portal - Input prompt: The Password Prompt: Chinese Simplified

loginHint_zh_TWnullable string

User Portal - Input prompt: The User Prompt: Chinese Traditional

passwordHint_zh_TWnullable string

User Portal - Input prompt: The Password Prompt: Chinese Traditional

overrideGatewaySettingsnullable boolean

User Portal - Gateway: Whether to override the gateway settings for the Theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodnullable boolean

User Portal - Gateway: Whether to allow the user to launch session using a particular method

allowAppsInNewTabnullable boolean

User Portal - Gateway: Whether to allow applications in a new tab

pre2000Crednullable boolean

User Portal - Gateway: Whether to use the pre windows 2000 format

allowEmbednullable boolean

User Portal - Gateway: Whether to allow embed

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSnullable boolean

User Portal - Gateway: Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

User Portal - Gateway: Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsnullable integer (int32)

User Portal - Gateway: How long should the browser preserve the cache (in months).

allowCookieConsentnullable boolean

User Portal - Legal policies: Whether to allow cookies or not

allowEULAnullable boolean

User Portal - Legal policies: Whether to allow EULA

companyNamenullable string

Windows client - Branding: The Company Name

applicationNamenullable string

Windows client - Branding: The Application Name

progressBarColornullable integer (int32)

Windows client - Branding: The progress bar color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.

windowsClientOverridePostLogonMessagenullable boolean

Windows client - Messages: Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

Windows client - Messages: The post-logon message

menuItemnullable string

Windows client - Custom menu: The Menu Item

commandnullable string

Windows client - Custom menu: The Command

Response

No Content

Request

Response

Get

Retrieve a specific Theme by ID.

GET/api/Theme/{id}

Path parameters

id*integer (int32)

Theme ID

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

Response

const response = await fetch('/api/Theme/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/Theme/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/Theme/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:12:27.032Z",
  "timeLastMod": "2024-11-07T10:12:27.032Z",
  "name": "text",
  "description": "text",
  "enabled": false,
  "overrideAuthenticationDomain": false,
  "domain": "text",
  "groupEnabled": false,
  "groupFilters": [
    {
      "name": "text",
      "sid": "text"
    }
  ],
  "postLogonMessage": "text",
  "userPortal": {
    "url": {
      "loginPageURLPath": "text",
      "showDownloadURL": false,
      "overrideWindowsClientDownloadURL": "text",
      "footerURLs": [
        {
          "url": "text",
          "text": "text",
          "tooltip": "text"
        }
      ]
    },
    "branding": {
      "webpageTitle": "text",
      "loginTo": "text"
    },
    "color": {
      "headerOptions": [
        "0 = Blurred",
        "1 = SolidColor"
      ],
      "workAreaImage": [
        "0 = SolidColor",
        "1 = Image1",
        "2 = Image2",
        "3 = Image3",
        "4 = Image4",
        "5 = Image5"
      ]
    },
    "languageBar": {
      "default": [
        "0 = Default",
        "1 = English",
        "2 = German",
        "3 = Japanese",
        "5 = French",
        "6 = Spanish",
        "7 = Italian",
        "8 = Portuguese",
        "9 = ChineseSimplified",
        "10 = ChineseTraditional",
        "11 = Korean",
        "12 = Dutch"
      ],
      "de_DE": false,
      "en_US": false,
      "es_ES": false,
      "fr_FR": false,
      "it_IT": false,
      "ja_JP": false,
      "ko_KR": false,
      "nl_NL": false,
      "pt_BR": false,
      "zh_CN": false,
      "zh_TW": false
    },
    "message": {
      "preLogonMessage": "text",
      "overridePostLogonMessage": false,
      "userPortalPostLogonMessage": "text"
    },
    "inputPrompt": {
      "de_DE": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "en_US": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "es_ES": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "fr_FR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "it_IT": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ja_JP": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ko_KR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "nl_NL": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "pt_BR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_CN": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_TW": {
        "loginHint": "text",
        "passwordHint": "text"
      }
    },
    "gateway": {
      "overrideGatewaySettings": false,
      "launchMethod": [
        "0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
        "1 = Launch_Applications_with_Parallels_Client",
        "2 = Launch_Applications_with_Browser_HTML5"
      ],
      "allowLaunchMethod": false,
      "allowAppsInNewTab": false,
      "pre2000Cred": false,
      "allowEmbed": false,
      "fileTransferMode": [
        "0 = Disabled",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "clipboardDirection": [
        "0 = None",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "allowCORS": false,
      "allowedDomainsForCORS": [
        "text"
      ]
    },
    "legalPolicies": {
      "allowCookieConsent": false,
      "allowEULA": false
    }
  },
  "windowsClient": {
    "branding": {
      "companyName": "text",
      "applicationName": "text"
    },
    "messages": {
      "windowsClientOverridePostLogonMessage": false,
      "windowsClientPostLogonMessage": "text"
    },
    "customMenu": {
      "menuItem": "text",
      "command": "text"
    }
  }
}

Update

Update an Image with specified ImageType of the Theme specified by ID.

PUT/api/Theme/{id}/Image

Path parameters

id*integer (int32)

Theme ID.

Query parameters

ImageTypeThemeImageType (enum)

Theme Image Type.

1 = CompanyLogo,2 = FaviconIcon,4 = ConnectionBanner,8 = ApplicationIcon

Resetboolean

Whether to reset the image file type specified or not. By default, it is set to false.

Body

ImageFilestring (binary)

Upload File

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/Image', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve the image(s) of the Theme specified by ID. If more than 1 image is requested, a compressed .zip file is returned containing all the images.

GET/api/Theme/{id}/Image

Path parameters

id*integer (int32)

Theme ID.

Query parameters

ImageTypeThemeImageTypes (enum)

Theme Image Types.

1 = CompanyLogo,2 = FaviconIcon,4 = ConnectionBanner,8 = ApplicationIcon,15 = All

Response

Success

Request

const response = await fetch('/api/Theme/{id}/Image', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve the footer URLs from the Theme.

GET/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID.

Response

Success

Body

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "url": "text",
    "text": "text",
    "tooltip": "text"
  }
]

Add

Add the specified footer URL to the Theme.

POST/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID

Body

Theme

url*nullable string

The URL

text*nullable string

The text

tooltipnullable string

The tooltip

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "text": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Remove the specified footer URL from the Theme.

DELETE/api/Theme/{id}/FooterURL

Path parameters

id*integer (int32)

Theme ID

Body

Theme

url*nullable string

The URL

text*nullable string

The text

tooltipnullable string

The tooltip

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/FooterURL', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "text": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve the group filters from the Theme

GET/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID.

Response

Success

Body

namenullable string

The group name

sidnullable string

The group SID

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "sid": "text"
  }
]

Add

Add the specified group filter to the Theme.

POST/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID

Body

Theme

groupNamenullable string

The name of the group list

groupSIDnullable string

The group SID

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Remove the specified group filter from the Theme

DELETE/api/Theme/{id}/GroupFilter

Path parameters

id*integer (int32)

Theme ID

Body

Theme

groupNamenullable string

The name of the group list

groupSIDnullable string

The group SID

Response

No Content

Request

const response = await fetch('/api/Theme/{id}/GroupFilter', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Create

Add a new Theme to a site.

POST/api/Theme

Body

Theme

name*nullable string

Name of the new Theme policy.

descriptionnullable string

Description for the new Theme policy.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

const response = await fetch('/api/Theme', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:12:27.032Z",
  "timeLastMod": "2024-11-07T10:12:27.032Z",
  "name": "text",
  "description": "text",
  "enabled": false,
  "overrideAuthenticationDomain": false,
  "domain": "text",
  "groupEnabled": false,
  "groupFilters": [
    {
      "name": "text",
      "sid": "text"
    }
  ],
  "postLogonMessage": "text",
  "userPortal": {
    "url": {
      "loginPageURLPath": "text",
      "showDownloadURL": false,
      "overrideWindowsClientDownloadURL": "text",
      "footerURLs": [
        {
          "url": "text",
          "text": "text",
          "tooltip": "text"
        }
      ]
    },
    "branding": {
      "webpageTitle": "text",
      "loginTo": "text"
    },
    "color": {
      "headerOptions": [
        "0 = Blurred",
        "1 = SolidColor"
      ],
      "workAreaImage": [
        "0 = SolidColor",
        "1 = Image1",
        "2 = Image2",
        "3 = Image3",
        "4 = Image4",
        "5 = Image5"
      ]
    },
    "languageBar": {
      "default": [
        "0 = Default",
        "1 = English",
        "2 = German",
        "3 = Japanese",
        "5 = French",
        "6 = Spanish",
        "7 = Italian",
        "8 = Portuguese",
        "9 = ChineseSimplified",
        "10 = ChineseTraditional",
        "11 = Korean",
        "12 = Dutch"
      ],
      "de_DE": false,
      "en_US": false,
      "es_ES": false,
      "fr_FR": false,
      "it_IT": false,
      "ja_JP": false,
      "ko_KR": false,
      "nl_NL": false,
      "pt_BR": false,
      "zh_CN": false,
      "zh_TW": false
    },
    "message": {
      "preLogonMessage": "text",
      "overridePostLogonMessage": false,
      "userPortalPostLogonMessage": "text"
    },
    "inputPrompt": {
      "de_DE": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "en_US": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "es_ES": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "fr_FR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "it_IT": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ja_JP": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "ko_KR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "nl_NL": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "pt_BR": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_CN": {
        "loginHint": "text",
        "passwordHint": "text"
      },
      "zh_TW": {
        "loginHint": "text",
        "passwordHint": "text"
      }
    },
    "gateway": {
      "overrideGatewaySettings": false,
      "launchMethod": [
        "0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
        "1 = Launch_Applications_with_Parallels_Client",
        "2 = Launch_Applications_with_Browser_HTML5"
      ],
      "allowLaunchMethod": false,
      "allowAppsInNewTab": false,
      "pre2000Cred": false,
      "allowEmbed": false,
      "fileTransferMode": [
        "0 = Disabled",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "clipboardDirection": [
        "0 = None",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "allowCORS": false,
      "allowedDomainsForCORS": [
        "text"
      ]
    },
    "legalPolicies": {
      "allowCookieConsent": false,
      "allowEULA": false
    }
  },
  "windowsClient": {
    "branding": {
      "companyName": "text",
      "applicationName": "text"
    },
    "messages": {
      "windowsClientOverridePostLogonMessage": false,
      "windowsClientPostLogonMessage": "text"
    },
    "customMenu": {
      "menuItem": "text",
      "command": "text"
    }
  }
}

List

Retrieve information about a list of Themes.

GET/api/Theme

Query parameters

Namestring

Filter the result by Theme name (optional)

SiteIdinteger (int32)

Site ID for which to retrieve Theme(s) (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Theme name.

descriptionnullable string

Description of the theme policy.

enabledboolean

Whether Theme is enabled or not.

overrideAuthenticationDomainboolean

Whether to override the authentication domain.

domainnullable string

The domain used.

groupEnabledboolean

Whether to limit themes to a certain group

groupFiltersnullable array of GroupFilter (object)

The Group Filters

namenullable string

The group name

sidnullable string

The group SID

postLogonMessagenullable string

The post-logon message

userPortalThemeUserPortal (object)

RAS Theme - User Portal

urlUrl (object)

Theme User Portal Url Settings

loginPageURLPathnullable string

The Theme login page URL path following protocol and domain such as https://FQDN/path The default URL path is userportal ie. https://FQDN/userportal/

showDownloadURLboolean

Whether to show the download URL

overrideWindowsClientDownloadURLnullable string

The Override download URL for branded Parallels Client (Windows)

footerURLsnullable array of FooterURL (object)

The footer URL list

urlnullable string

The URL link

textnullable string

The URL text

tooltipnullable string

The URL tool tip

brandingThemeUserPortalBranding (object)

Theme User Portal Branding Settings

webpageTitlenullable string

The Webpage Title

loginTonullable string

The Login To

colorColors (object)

Theme User Portal Colors Settings

headerOptionsHeaderOptions (enum)

Header options Type.

0 = Blurred,1 = SolidColor

workAreaImageWorkAreaImage (enum)

Work area image Type.

0 = SolidColor,1 = Image1,2 = Image2,3 = Image3,4 = Image4,5 = Image5

headerBackgroundColorinteger (int32)

The header background color. Returns the sRGB value.

workAreaBackgroundColorinteger (int32)

The work area background color. Returns the sRGB value.

workAreaTextColorinteger (int32)

The work area text color. Returns the sRGB value.

buttonsBackgroundColorinteger (int32)

The buttons background and link color. Returns the sRGB value.

buttonsTextColorinteger (int32)

The buttons text color. Returns the sRGB value.

languageBarLanguageBar (object)

Theme User Portal Langugage Bar Settings

defaultLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

de_DEboolean

German Language bar

en_USboolean

English (US) Language bar

es_ESboolean

Spanish Language bar

fr_FRboolean

French Language bar

it_ITboolean

Italian Language bar

ja_JPboolean

Japanese Language bar

ko_KRboolean

Korean Language bar

nl_NLboolean

Dutch Language bar

pt_BRboolean

Portuguese Language bar

zh_CNboolean

Chinese Simplified Language bar

zh_TWboolean

Chinese Traditional Language bar

messageThemeUserPortalMessages (object)

Theme User Portal Messages Settings

preLogonMessagenullable string

The Pre-Logon message

overridePostLogonMessageboolean

Whether to override the post-logon message

userPortalPostLogonMessagenullable string

The Overridden Post-Logon message

inputPromptInputPrompt (object)

Theme User Portal Input Prompt Setting

de_DELanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

en_USLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

es_ESLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

fr_FRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

it_ITLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ja_JPLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

ko_KRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

nl_NLLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

pt_BRLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_CNLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

zh_TWLanguageInputPrompt (object)

Theme User Portal Language Input Prompt Settings

loginHintnullable string

The User Prompt

passwordHintnullable string

The Password Prompt

gatewayThemeUserPortalGateway (object)

Theme User Portal Gateway Settings

overrideGatewaySettingsboolean

Whether to override the gateway settings for the theme

launchMethodLaunchSession (enum)

Launch Methods Type.

0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5,1 = Launch_Applications_with_Parallels_Client,2 = Launch_Applications_with_Browser_HTML5

allowLaunchMethodboolean

Whether to allow the user to launch session using a particular method

allowAppsInNewTabboolean

Whether to allow applications in a new tab

pre2000Credboolean

Whether to use the pre windows 2000 format

allowEmbedboolean

Whether to allow embed or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Whether to allow cross-origin resource sharing

allowedDomainsForCORSnullable array of string

Allowed domains for cross-origin resource sharing.

itemsstring

browserCacheTimeInMonthsinteger (int32)

How long should the browser preserve the cache (in months).

legalPoliciesLegalPolicies (object)

Theme User Portal Legal Policies Settings

allowCookieConsentboolean

Whether to allow cookies or not

allowEULAboolean

Whether to allow eula or not

windowsClientThemeWindowsClient (object)

RAS Theme - Windows Client

brandingThemeWindowsBranding (object)

Theme Windows Client Branding Settings

companyNamenullable string

The Company Name

applicationNamenullable string

The Application Name

progressBarColorinteger (int32)

The progress bar color. Returns the sRGB value.

messagesThemeWindowsMessages (object)

Theme Windows Client Messages Settings

windowsClientOverridePostLogonMessageboolean

Whether to allow the override post-logon message

windowsClientPostLogonMessagenullable string

The post-logon message

customMenuCustomMenu (object)

Theme Windows Client Custom Menu Settings

menuItemnullable string

The Menu Item

commandnullable string

The Command

mfaIdinteger (int32)

The Mfa Provider Id

Request

const response = await fetch('/api/Theme', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:12:27.032Z",
    "timeLastMod": "2024-11-07T10:12:27.032Z",
    "name": "text",
    "description": "text",
    "enabled": false,
    "overrideAuthenticationDomain": false,
    "domain": "text",
    "groupEnabled": false,
    "groupFilters": [
      {
        "name": "text",
        "sid": "text"
      }
    ],
    "postLogonMessage": "text",
    "userPortal": {
      "url": {
        "loginPageURLPath": "text",
        "showDownloadURL": false,
        "overrideWindowsClientDownloadURL": "text",
        "footerURLs": [
          {
            "url": "text",
            "text": "text",
            "tooltip": "text"
          }
        ]
      },
      "branding": {
        "webpageTitle": "text",
        "loginTo": "text"
      },
      "color": {
        "headerOptions": [
          "0 = Blurred",
          "1 = SolidColor"
        ],
        "workAreaImage": [
          "0 = SolidColor",
          "1 = Image1",
          "2 = Image2",
          "3 = Image3",
          "4 = Image4",
          "5 = Image5"
        ]
      },
      "languageBar": {
        "default": [
          "0 = Default",
          "1 = English",
          "2 = German",
          "3 = Japanese",
          "5 = French",
          "6 = Spanish",
          "7 = Italian",
          "8 = Portuguese",
          "9 = ChineseSimplified",
          "10 = ChineseTraditional",
          "11 = Korean",
          "12 = Dutch"
        ],
        "de_DE": false,
        "en_US": false,
        "es_ES": false,
        "fr_FR": false,
        "it_IT": false,
        "ja_JP": false,
        "ko_KR": false,
        "nl_NL": false,
        "pt_BR": false,
        "zh_CN": false,
        "zh_TW": false
      },
      "message": {
        "preLogonMessage": "text",
        "overridePostLogonMessage": false,
        "userPortalPostLogonMessage": "text"
      },
      "inputPrompt": {
        "de_DE": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "en_US": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "es_ES": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "fr_FR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "it_IT": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "ja_JP": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "ko_KR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "nl_NL": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "pt_BR": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "zh_CN": {
          "loginHint": "text",
          "passwordHint": "text"
        },
        "zh_TW": {
          "loginHint": "text",
          "passwordHint": "text"
        }
      },
      "gateway": {
        "overrideGatewaySettings": false,
        "launchMethod": [
          "0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
          "1 = Launch_Applications_with_Parallels_Client",
          "2 = Launch_Applications_with_Browser_HTML5"
        ],
        "allowLaunchMethod": false,
        "allowAppsInNewTab": false,
        "pre2000Cred": false,
        "allowEmbed": false,
        "fileTransferMode": [
          "0 = Disabled",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ],
        "clipboardDirection": [
          "0 = None",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ],
        "allowCORS": false,
        "allowedDomainsForCORS": [
          "text"
        ]
      },
      "legalPolicies": {
        "allowCookieConsent": false,
        "allowEULA": false
      }
    },
    "windowsClient": {
      "branding": {
        "companyName": "text",
        "applicationName": "text"
      },
      "messages": {
        "windowsClientOverridePostLogonMessage": false,
        "windowsClientPostLogonMessage": "text"
      },
      "customMenu": {
        "menuItem": "text",
        "command": "text"
      }
    }
  }
]

Add

Update an Image with specified ImageType of the Theme specified by ID.

POST/api/Theme/CustomImage

Query parameters

SiteIdinteger (int32)

Site ID in which to create the theme custom image. If the parameter is omitted, the site ID of the Licensing Server will be used.

Body

ImageFilestring (binary)

Upload File

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

List

Retrieve theme custom images.

GET/api/Theme/CustomImage

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the theme custom images. If the parameter is omitted, the site ID of the Licensing Server will be used.

Response

Request

const response = await fetch('/api/Theme/CustomImage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get

Retrieve a theme custom image.

GET/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The theme custom image ID.

Response

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a theme custom image.

DELETE/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The ID of the Theme Custom Image to remove.

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Update

Modify a theme custom image.

PUT/api/Theme/CustomImage/{id}

Path parameters

id*integer (int32)

The ID of the Theme Custom Image to modify.

Body

Theme Custom Image

newName*nullable string

The new name of the specified Theme Custom Image

Response

No Content

Request

const response = await fetch('/api/Theme/CustomImage/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "newName": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}