Themes
Retrieve information about a list of Themes.
Filter the result by Theme name (optional)
Site ID for which to retrieve Theme(s) (optional)
GET /api/Theme HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-05T09:15:03.543Z",
"timeLastMod": "2025-07-05T09:15:03.543Z",
"name": "text",
"description": "text",
"enabled": true,
"overrideAuthenticationDomain": true,
"domain": "text",
"groupEnabled": true,
"groupFilters": [
{
"name": "text",
"sid": "text"
}
],
"postLogonMessage": "text",
"userPortal": {
"url": {
"loginPageURLPath": "text",
"showDownloadURL": true,
"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"
],
"headerBackgroundColor": 1,
"workAreaBackgroundColor": 1,
"workAreaTextColor": 1,
"buttonsBackgroundColor": 1,
"buttonsTextColor": 1
},
"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": true,
"en_US": true,
"es_ES": true,
"fr_FR": true,
"it_IT": true,
"ja_JP": true,
"ko_KR": true,
"nl_NL": true,
"pt_BR": true,
"zh_CN": true,
"zh_TW": true
},
"message": {
"preLogonMessage": "text",
"overridePostLogonMessage": true,
"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": true,
"launchMethod": [
"0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
"1 = Launch_Applications_with_Parallels_Client",
"2 = Launch_Applications_with_Browser_HTML5"
],
"allowLaunchMethod": true,
"allowAppsInNewTab": true,
"pre2000Cred": true,
"allowEmbed": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"allowCORS": true,
"allowedDomainsForCORS": [
"text"
],
"browserCacheTimeInMonths": 1
},
"legalPolicies": {
"allowCookieConsent": true,
"allowEULA": true
}
},
"windowsClient": {
"branding": {
"companyName": "text",
"applicationName": "text",
"progressBarColor": 1
},
"messages": {
"windowsClientOverridePostLogonMessage": true,
"windowsClientPostLogonMessage": "text"
},
"customMenu": {
"menuItem": "text",
"command": "text"
}
},
"mfaId": 1
}
]Add a new Theme to a site.
Create a new Theme
Name of the new Theme policy.
Description for the new Theme policy.
POST /api/Theme HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-05T09:15:03.543Z",
"timeLastMod": "2025-07-05T09:15:03.543Z",
"name": "text",
"description": "text",
"enabled": true,
"overrideAuthenticationDomain": true,
"domain": "text",
"groupEnabled": true,
"groupFilters": [
{
"name": "text",
"sid": "text"
}
],
"postLogonMessage": "text",
"userPortal": {
"url": {
"loginPageURLPath": "text",
"showDownloadURL": true,
"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"
],
"headerBackgroundColor": 1,
"workAreaBackgroundColor": 1,
"workAreaTextColor": 1,
"buttonsBackgroundColor": 1,
"buttonsTextColor": 1
},
"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": true,
"en_US": true,
"es_ES": true,
"fr_FR": true,
"it_IT": true,
"ja_JP": true,
"ko_KR": true,
"nl_NL": true,
"pt_BR": true,
"zh_CN": true,
"zh_TW": true
},
"message": {
"preLogonMessage": "text",
"overridePostLogonMessage": true,
"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": true,
"launchMethod": [
"0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
"1 = Launch_Applications_with_Parallels_Client",
"2 = Launch_Applications_with_Browser_HTML5"
],
"allowLaunchMethod": true,
"allowAppsInNewTab": true,
"pre2000Cred": true,
"allowEmbed": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"allowCORS": true,
"allowedDomainsForCORS": [
"text"
],
"browserCacheTimeInMonths": 1
},
"legalPolicies": {
"allowCookieConsent": true,
"allowEULA": true
}
},
"windowsClient": {
"branding": {
"companyName": "text",
"applicationName": "text",
"progressBarColor": 1
},
"messages": {
"windowsClientOverridePostLogonMessage": true,
"windowsClientPostLogonMessage": "text"
},
"customMenu": {
"menuItem": "text",
"command": "text"
}
},
"mfaId": 1
}Retrieve a specific Theme by ID.
Theme ID
GET /api/Theme/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-05T09:15:03.543Z",
"timeLastMod": "2025-07-05T09:15:03.543Z",
"name": "text",
"description": "text",
"enabled": true,
"overrideAuthenticationDomain": true,
"domain": "text",
"groupEnabled": true,
"groupFilters": [
{
"name": "text",
"sid": "text"
}
],
"postLogonMessage": "text",
"userPortal": {
"url": {
"loginPageURLPath": "text",
"showDownloadURL": true,
"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"
],
"headerBackgroundColor": 1,
"workAreaBackgroundColor": 1,
"workAreaTextColor": 1,
"buttonsBackgroundColor": 1,
"buttonsTextColor": 1
},
"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": true,
"en_US": true,
"es_ES": true,
"fr_FR": true,
"it_IT": true,
"ja_JP": true,
"ko_KR": true,
"nl_NL": true,
"pt_BR": true,
"zh_CN": true,
"zh_TW": true
},
"message": {
"preLogonMessage": "text",
"overridePostLogonMessage": true,
"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": true,
"launchMethod": [
"0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
"1 = Launch_Applications_with_Parallels_Client",
"2 = Launch_Applications_with_Browser_HTML5"
],
"allowLaunchMethod": true,
"allowAppsInNewTab": true,
"pre2000Cred": true,
"allowEmbed": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"allowCORS": true,
"allowedDomainsForCORS": [
"text"
],
"browserCacheTimeInMonths": 1
},
"legalPolicies": {
"allowCookieConsent": true,
"allowEULA": true
}
},
"windowsClient": {
"branding": {
"companyName": "text",
"applicationName": "text",
"progressBarColor": 1
},
"messages": {
"windowsClientOverridePostLogonMessage": true,
"windowsClientPostLogonMessage": "text"
},
"customMenu": {
"menuItem": "text",
"command": "text"
}
},
"mfaId": 1
}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.
Theme ID
Update a RAS Theme
General: The new name of the specified Theme
General: Description of the Theme
General: Whether Theme is enabled or not
General: The MFA Provider Id. One can set MFAId as 0 to unassign MFA from a theme.
General: Whether to override the authentication domain
General: The domain used
General: Whether to limit Themes to a certain group
Messages: The post-logon message
User Portal - URLs: The Theme login page URL Path following protocol and domain such as 'https://FQDN/path'.
User Portal - URLs: Whether to show the download URL
User Portal - URLs: The Override download URL for branded Parallels Client (Windows)
User Portal - Branding: The Webpage Title
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%.
Header options Type.
Work area image Type.
User Portal - Colors: The header background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
User Portal - Colors: The work area background color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
User Portal - Colors: The work area text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
User Portal - Colors: The buttons background and link color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
User Portal - Colors: The buttons text color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
Languages Type.
User Portal - Language bar: Whether to enable the German Language Bar or not
User Portal - Language bar: Whether to enable the English (US) Language Bar or not
User Portal - Language bar: Whether to enable the Spanish Language Bar or not
User Portal - Language bar: Whether to enable the French Language Bar or not
User Portal - Language bar: Whether to enable the Italian Language Bar or not
User Portal - Language bar: Whether to enable the Japanese Language Bar or not
User Portal - Language bar: Whether to enable the Korean Language Bar or not
User Portal - Language bar: Whether to enable the Dutch Language Bar or not
User Portal - Language bar: Whether to enable the Portuguese Language Bar or not
User Portal - Language bar: Whether to enable the Chinese Simplified Language Bar or not
User Portal - Language bar: Whether to enable the Chinese Traditional Language Bar or not
User Portal - Messages: The Pre-Logon message
User Portal - Messages: The Post-Logon message
User Portal - Messages: Whether to override the post-logon message
User Portal - Input prompt: The User Prompt: German
User Portal - Input prompt: The Password Prompt: German
User Portal - Input prompt: The User Prompt: English (US)
User Portal - Input prompt: The Password Prompt: English (US)
User Portal - Input prompt: The User Prompt: Spanish
User Portal - Input prompt: The Password Prompt: Spanish
User Portal - Input prompt: The User Prompt: French
User Portal - Input prompt: The Password Prompt: French
User Portal - Input prompt: The User Prompt: Italian
User Portal - Input prompt: The Password Prompt: Italian
User Portal - Input prompt: The User Prompt: Japanese
User Portal - Input prompt: The Password Prompt: Japanese
User Portal - Input prompt: The User Prompt: Korean
User Portal - Input prompt: The Password Prompt: Korean
User Portal - Input prompt: The User Prompt: Dutch
User Portal - Input prompt: The Password Prompt: Dutch
User Portal - Input prompt: The User Prompt: Portuguese
User Portal - Input prompt: The Password Prompt: Portuguese
User Portal - Input prompt: The User Prompt: Chinese Simplified
User Portal - Input prompt: The Password Prompt: Chinese Simplified
User Portal - Input prompt: The User Prompt: Chinese Traditional
User Portal - Input prompt: The Password Prompt: Chinese Traditional
User Portal - Gateway: Whether to override the gateway settings for the Theme
Launch Methods Type.
User Portal - Gateway: Whether to allow the user to launch session using a particular method
User Portal - Gateway: Whether to allow applications in a new tab
User Portal - Gateway: Whether to use the pre windows 2000 format
User Portal - Gateway: Whether to allow embed
File Transfer Control modes.
Clipboard Direction Type.
User Portal - Gateway: Whether to allow cross-origin resource sharing
User Portal - Gateway: Allowed domains for cross-origin resource sharing.
User Portal - Gateway: How long should the browser preserve the cache (in months).
User Portal - Legal policies: Whether to allow cookies or not
User Portal - Legal policies: Whether to allow EULA
Windows client - Branding: The Company Name
Windows client - Branding: The Application Name
Windows client - Branding: The progress bar color. Accepts a sRGB value. E.g. Red - 0xFF0000, Green - 0x00FF00, Blue - 0x0000FF.
Windows client - Messages: Whether to allow the override post-logon message
Windows client - Messages: The post-logon message
Windows client - Custom menu: The Menu Item
Windows client - Custom menu: The Command
PUT /api/Theme/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2525
{
"name": "text",
"description": "text",
"enabled": true,
"mfaId": 1,
"overrideAuthenticationDomain": true,
"domain": "text",
"groupEnabled": true,
"postLogonMessage": "text",
"loginPageURLPath": "text",
"showDownloadURL": true,
"overrideWindowsClientDownloadURL": "text",
"webpageTitle": "text",
"loginTo": "text",
"headerOptions": [
"0 = Blurred",
"1 = SolidColor"
],
"workAreaImage": [
"0 = SolidColor",
"1 = Image1",
"2 = Image2",
"3 = Image3",
"4 = Image4",
"5 = Image5"
],
"headerBackgroundColor": 1,
"workAreaBackgroundColor": 1,
"workAreaTextColor": 1,
"buttonsBackgroundColor": 1,
"buttonsTextColor": 1,
"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"
],
"languageBar_de_DE": true,
"languageBar_en_US": true,
"languageBar_es_ES": true,
"languageBar_fr_FR": true,
"languageBar_it_IT": true,
"languageBar_ja_JP": true,
"languageBar_ko_KR": true,
"languageBar_nl_NL": true,
"languageBar_pt_BR": true,
"languageBar_zh_CN": true,
"languageBar_zh_TW": true,
"preLogonMessage": "text",
"userPortalPostLogonMessage": "text",
"overridePostLogonMessage": true,
"loginHint_de_DE": "text",
"passwordHint_de_DE": "text",
"loginHint_en_US": "text",
"passwordHint_en_US": "text",
"loginHint_es_ES": "text",
"passwordHint_es_ES": "text",
"loginHint_fr_FR": "text",
"passwordHint_fr_FR": "text",
"loginHint_it_IT": "text",
"passwordHint_it_IT": "text",
"loginHint_ja_JP": "text",
"passwordHint_ja_JP": "text",
"loginHint_ko_KR": "text",
"passwordHint_ko_KR": "text",
"loginHint_nl_NL": "text",
"passwordHint_nl_NL": "text",
"loginHint_pt_BR": "text",
"passwordHint_pt_BR": "text",
"loginHint_zh_CN": "text",
"passwordHint_zh_CN": "text",
"loginHint_zh_TW": "text",
"passwordHint_zh_TW": "text",
"overrideGatewaySettings": true,
"launchMethod": [
"0 = Launch_Applications_with_Parallels_Client_Fallback_to_HTML_5",
"1 = Launch_Applications_with_Parallels_Client",
"2 = Launch_Applications_with_Browser_HTML5"
],
"allowLaunchMethod": true,
"allowAppsInNewTab": true,
"pre2000Cred": true,
"allowEmbed": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"allowCORS": true,
"allowedDomainsForCORS": [
"text"
],
"browserCacheTimeInMonths": 1,
"allowCookieConsent": true,
"allowEULA": true,
"companyName": "text",
"applicationName": "text",
"progressBarColor": 1,
"windowsClientOverridePostLogonMessage": true,
"windowsClientPostLogonMessage": "text",
"menuItem": "text",
"command": "text"
}No content
Last updated
Was this helpful?