Parallels REST API
ProductsSupportPartnersDocumentation
  • About
  • API reference
    • Infrastructure
      • Agents
        • Logs
        • Diagnostics
          • Broker
          • Enrollment Server
          • Gateway
          • Guest
          • HALB Device
          • Provider
          • RDS
      • Application Packages
        • MSIX Image
          • Details
      • AVD
        • Custom Host
          • All
        • Gallery
          • Image
        • Host Pool
          • App Package Assigned
          • Assignment
          • Auto Upgrade
            • Messages
          • Create Hosts
          • Existing
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • Recreate Hosts
          • Repair
          • Schedule
            • Disable
            • Messages
            • Reboot
            • Shutdown
            • Startup
            • Target
          • Status
          • FSLogix
            • General
            • Office Container
              • CCD Locations
              • User Exclusion
              • User Inclusion
              • VHD Locations
            • Profile Container
              • CCD Locations
              • Folder Exclusion
              • Folder Inclusion
              • User Exclusion
              • User Inclusion
              • VHD Locations
        • Location
        • Offer
        • Predefined Images
        • Publisher
        • Resource Group
        • Settings
        • SKU
        • Template
          • Enter Maintenance
          • Exit Maintenance
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • Recreate Desktops
          • Repair
          • Status
          • Version
          • VersionStatus
        • Version
        • Virtual Network
        • Workspace
          • Existing
          • Repair
          • Status
        • Default Settings
          • Multi Session
            • Application Package Assigned
            • Auto Upgrade
              • Messages
            • Optimization
              • Registry
              • Windows Component
              • Windows Scheduled Task
              • Windows Service
            • FSLogix
              • General
              • Office Container
                • CCD Locations
                • User Exclusion
                • User Inclusion
                • VHD Locations
              • Profile Container
                • CCD Locations
                • Folder Exclusion
                • Folder Inclusion
                • User Exclusion
                • User Inclusion
                • VHD Locations
          • Single Session
            • Application Package Assigned
            • Auto Upgrade
              • Messages
            • Optimization
              • Registry
              • Windows Component
              • Windows Scheduled Task
              • Windows Service
            • FSLogix
              • General
              • Office Container
                • CCD Locations
                • User Exclusion
                • User Inclusion
                • VHD Locations
              • Profile Container
                • CCD Locations
                • Folder Exclusion
                • Folder Inclusion
                • User Exclusion
                • User Inclusion
                • VHD Locations
        • VM Size
          • Provider
          • Workspace
        • Subnets
      • Certificates
        • Export
        • Generate Lets Encrypt
        • Generate Request
        • Generate Self Signed
        • Import Certificate
        • Import Pfx
        • Import Public Key
        • Renew
        • Retry
        • Revoke
        • Update Intermediate
        • Lets Encrypt Settings
          • EULA
      • Connection Brokers
        • Priority
        • Promote
        • Status
        • Broker Promotion
      • Enrollment Servers
        • Status
      • HALBs
        • Device
        • Status
      • Providers
        • Avd
        • Awsec2
        • Azure
        • Hyperv
        • Hypervfailover
        • Nutanix
        • Remote PC dynamic
        • Remote PC static
          • Remote PC
            • Import
        • Scale
        • Status
        • Vcenter
        • VM
          • AVD Host
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Session
              • Processes
            • Standalone
            • Status
            • Templated
          • Reset
          • Restart
          • Start
          • Stop
          • Suspend
          • VDI Host
            • Assignment
            • Disconnect
            • LogOff
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • SendMsg
            • Session
              • Processes
            • Status
          • Host
            • Process
              • Kill
            • Status
        • Vmwareesxi
      • RD Session Hosts
        • RDS Default Settings
          • App Package Assigned
          • Auto Upgrade
            • Messages
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • FSLogix
            • General
            • Office Container
              • CCD Locations
              • User Exclusion
              • User Inclusion
              • VHD Locations
            • ProfileContainer
              • CCD Locations
              • Folder Exclusion
              • Folder Inclusion
              • User Exclusion
              • User Inclusion
              • VHD Locations
        • RDS
          • Host
            • AppPackageAssigned
            • CancelDisabledState
            • CancelPendingReboot
            • DisableLogonsAndReconnections
            • Drain
            • DrainUntilReboot
            • EnableLogons
            • InstallRDSRole
            • Optimization
              • Registry
              • WindowsComponent
              • WindowsScheduledTask
              • WindowsService
              • Predefined
                • WindowsComponent
                • WindowsScheduledTask
                • WindowsService
            • Reboot
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Sessions
              • Disconnect
              • Logoff
              • Processes
                • Kill
              • Sendmsg
            • Shutdown
            • Status
            • FSLogix
              • General
              • OfficeContainer
                • CCDLocations
                • UserExclusion
                • UserInclusion
                • VHDLocations
              • ProfileContainer
                • CCDLocations
                • FolderExclusion
                • FolderInclusion
                • UserExclusion
                • UserInclusion
                • VHDLocations
          • HostPool
            • AppPackageAssigned
            • AutoUpgrade
              • Messages
            • CancelDisabledState
            • CancelPendingReboot
            • CancelPendingShutdown
            • CreateHosts
            • Members
            • RecreateHosts
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Status
            • FSLogix
              • General
              • OfficeContainer
                • CCDLocations
                • UserExclusion
                • UserInclusion
                • VHDLocations
              • ProfileContainer
                • CCDLocations
                • FolderExclusion
                • FolderInclusion
                • UserExclusion
                • UserInclusion
                • VHDLocations
          • Template
            • EnterMaintenance
            • ExitMaintenance
            • LicenseKey
            • Optimization
              • Registry
              • WindowsComponent
              • WindowsScheduledTask
              • WindowsService
            • RecreateDesktops
            • Status
            • Version
            • VersionStatus
      • SAML IDPs
        • Duplicate
      • Gateway
        • Certificate
        • Private Key
        • Status
        • Gateway Default Settings
        • Tests a URL that leads to a client IP detection service
      • Sites
        • Status
      • Themes
        • Footer URL
        • Group Filter
        • Image
        • Custom Images
      • Tunneling Policies
        • Basic Operations
        • Listing, Updating, and Deleting
      • VDI
        • Host Pool
          • AppPackageAssigned
          • AutoUpgrade
            • Messages
          • CreateHosts
          • Members
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • RecreateHosts
          • Schedule
            • Disable
            • Messages
            • Reboot
            • Shutdown
            • Startup
            • Target
          • FSLogix
            • General
            • OfficeContainer
              • CCDLocations
              • UserExclusion
              • UserInclusion
              • VHDLocations
            • ProfileContainer
              • CCDLocations
              • FolderExclusion
              • FolderInclusion
              • UserExclusion
              • UserInclusion
              • VHDLocations
        • Template
          • EnterMaintenance
          • ExitMaintenance
          • LicenseKey
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • RecreateDesktops
          • Status
          • Version
          • VersionStatus
        • Optimization
          • Predefined
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
        • VDI Default Settings
          • AppPackageAssigned
          • AutoUpgrade
            • Messages
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • FSLogix
            • General
            • OfficeContainer
              • CCDLocations
              • UserExclusion
              • UserInclusion
              • VHDLocations
            • ProfileContainer
              • CCDLocations
              • FolderExclusion
              • FolderInclusion
              • UserExclusion
              • UserInclusion
              • VHDLocations
    • Farm settings
      • Administrator Sessions
        • Current Admin Permissions
        • Logoff
        • Logon
      • Administrators
        • Custom Permission
        • Move to Group
        • Power Permission
      • Farm
      • Invitation Emails
        • Invite
      • Licensing
        • Activate
        • Deactivate
      • Mailbox
        • Test
      • Performance Monitor
      • Printing and Scanning
      • Reporting
      • Settings
        • Apply
        • Export
        • Import
      • WebService
        • Settings
          • Import Certificate
        • Version
    • Site settings
      • AD Integration
        • Validate
      • Application Packages
        • Tags
        • Application Package Available Versions
      • Clients
      • Connection and Authentication
        • Connection Settings
          • Clear Session Cache
        • Connection Allowed Devices
        • Custom Routes
      • CPU Optimization
      • FSLogix
        • Profile Container
          • Upload Installer
      • Load Balancing
      • Logon Hours
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
          • Themes
        • Day Plan
        • Order
      • MFA
        • Check Connection
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
        • Deepnet
        • Duplicate
        • Email OTP
        • Radius
        • Radius Attributes
        • Radius Auto Info
        • Safenet
        • TOTP
        • Validate AD Access
        • MFA Default Settings
          • Criteria
            • Devices
            • Gateway IPs
            • Hardware IDs
            • IPs
            • OSes
            • Security Principals
        • Details
      • Notifications
        • Events
        • Resources
        • Notification Scripts
      • Printing
        • Auto Install Fonts
      • Proxy
      • Scanning
      • System
      • Template
      • Tenant Broker
        • Join
        • Status
        • Settings
        • Unjoin
      • URL Redirection
        • Entry
      • Windows Device Groups
        • Inbound Port
    • Publishing
      • PubIished tems
      • Client Filters
      • Copy
      • Filter
      • Folders
        • Sort
      • Gateway Filters
      • Icon
      • IP Filters
      • MAC Filters
      • Move
      • OS Filters
      • Preferred Route
      • Rules
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
          • Themes
      • Status
      • User Filters
      • Apps
        • AVD
        • File Extensions
        • RDS
          • Server Attribute
        • VDI
        • Local
      • Desktops
        • AVD
        • RDS
        • VDI
      • Publised resources Default Settings
    • Policies
      • Assignment
      • Duplicate
      • Export
      • Gateway Filters
      • Import
      • MAC Filters
      • Order
      • Rules
        • Criteria
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
      • Secondary Connections
      • User Group
    • RD Sessions
    • Help and support
      • Helpdesk Email Settings
      • Support
        • Download Report
        • Send Support Request
        • Send System Report
        • Overwrite Support Actions
  • Examples
    • Basic Sample
    • RDS Sample
    • Publishing Sample
    • Connection Broker and Secure Gateway Sample
    • Licensing Sample
Powered by GitBook

© 2025 Parallels International GmbH. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. API reference
  2. Infrastructure

Themes

PreviousStatusNextFooter URL

Was this helpful?

Get

get

Retrieve a specific Theme by ID.

Path parameters
idinteger · int32Required

Theme ID

Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/Theme/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-06-02T10:49:05.048Z",
  "timeLastMod": "2025-06-02T10:49:05.048Z",
  "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
}

Delete

delete

Delete a Theme from a site.

Path parameters
idinteger · int32Required

Theme ID

Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
delete
DELETE /api/Theme/{id} HTTP/1.1
Host: 
Accept: */*

No content

Update

put

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.

Path parameters
idinteger · int32Required

Theme ID

Body

Update a RAS Theme

namestring | nullableOptional

General: The new name of the specified Theme

descriptionstring | nullableOptional

General: Description of the Theme

enabledboolean | nullableOptional

General: Whether Theme is enabled or not

mfaIdinteger · int32 | nullableOptional

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

overrideAuthenticationDomainboolean | nullableOptional

General: Whether to override the authentication domain

domainstring | nullableOptional

General: The domain used

groupEnabledboolean | nullableOptional

General: Whether to limit Themes to a certain group

postLogonMessagestring | nullableOptional

Messages: The post-logon message

loginPageURLPathstring | nullableOptional

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

showDownloadURLboolean | nullableOptional

User Portal - URLs: Whether to show the download URL

overrideWindowsClientDownloadURLstring | nullableOptional

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

webpageTitlestring | nullableOptional

User Portal - Branding: The Webpage Title

loginTostring | nullableOptional

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%.

headerOptionsstring · enumOptional

Header options Type.

Possible values:
workAreaImagestring · enumOptional

Work area image Type.

Possible values:
headerBackgroundColorinteger · int32 | nullableOptional

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

workAreaBackgroundColorinteger · int32 | nullableOptional

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

workAreaTextColorinteger · int32 | nullableOptional

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

buttonsBackgroundColorinteger · int32 | nullableOptional

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

buttonsTextColorinteger · int32 | nullableOptional

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

languageBar_Defaultstring · enumOptional

Languages Type.

Possible values:
languageBar_de_DEboolean | nullableOptional

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

languageBar_en_USboolean | nullableOptional

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

languageBar_es_ESboolean | nullableOptional

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

languageBar_fr_FRboolean | nullableOptional

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

languageBar_it_ITboolean | nullableOptional

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

languageBar_ja_JPboolean | nullableOptional

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

languageBar_ko_KRboolean | nullableOptional

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

languageBar_nl_NLboolean | nullableOptional

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

languageBar_pt_BRboolean | nullableOptional

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

languageBar_zh_CNboolean | nullableOptional

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

languageBar_zh_TWboolean | nullableOptional

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

preLogonMessagestring | nullableOptional

User Portal - Messages: The Pre-Logon message

userPortalPostLogonMessagestring | nullableOptional

User Portal - Messages: The Post-Logon message

overridePostLogonMessageboolean | nullableOptional

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

loginHint_de_DEstring | nullableOptional

User Portal - Input prompt: The User Prompt: German

passwordHint_de_DEstring | nullableOptional

User Portal - Input prompt: The Password Prompt: German

loginHint_en_USstring | nullableOptional

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

passwordHint_en_USstring | nullableOptional

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

loginHint_es_ESstring | nullableOptional

User Portal - Input prompt: The User Prompt: Spanish

passwordHint_es_ESstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Spanish

loginHint_fr_FRstring | nullableOptional

User Portal - Input prompt: The User Prompt: French

passwordHint_fr_FRstring | nullableOptional

User Portal - Input prompt: The Password Prompt: French

loginHint_it_ITstring | nullableOptional

User Portal - Input prompt: The User Prompt: Italian

passwordHint_it_ITstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Italian

loginHint_ja_JPstring | nullableOptional

User Portal - Input prompt: The User Prompt: Japanese

passwordHint_ja_JPstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Japanese

loginHint_ko_KRstring | nullableOptional

User Portal - Input prompt: The User Prompt: Korean

passwordHint_ko_KRstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Korean

loginHint_nl_NLstring | nullableOptional

User Portal - Input prompt: The User Prompt: Dutch

passwordHint_nl_NLstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Dutch

loginHint_pt_BRstring | nullableOptional

User Portal - Input prompt: The User Prompt: Portuguese

passwordHint_pt_BRstring | nullableOptional

User Portal - Input prompt: The Password Prompt: Portuguese

loginHint_zh_CNstring | nullableOptional

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

passwordHint_zh_CNstring | nullableOptional

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

loginHint_zh_TWstring | nullableOptional

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

passwordHint_zh_TWstring | nullableOptional

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

overrideGatewaySettingsboolean | nullableOptional

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

launchMethodstring · enumOptional

Launch Methods Type.

Possible values:
allowLaunchMethodboolean | nullableOptional

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

allowAppsInNewTabboolean | nullableOptional

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

pre2000Credboolean | nullableOptional

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

allowEmbedboolean | nullableOptional

User Portal - Gateway: Whether to allow embed

fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:
clipboardDirectionstring[Flag] · enumOptional

Clipboard Direction Type.

Possible values:
allowCORSboolean | nullableOptional

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

allowedDomainsForCORSstring[] | nullableOptional

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

browserCacheTimeInMonthsinteger · int32 | nullableOptional

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

allowCookieConsentboolean | nullableOptional

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

allowEULAboolean | nullableOptional

User Portal - Legal policies: Whether to allow EULA

companyNamestring | nullableOptional

Windows client - Branding: The Company Name

applicationNamestring | nullableOptional

Windows client - Branding: The Application Name

progressBarColorinteger · int32 | nullableOptional

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

windowsClientOverridePostLogonMessageboolean | nullableOptional

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

windowsClientPostLogonMessagestring | nullableOptional

Windows client - Messages: The post-logon message

menuItemstring | nullableOptional

Windows client - Custom menu: The Menu Item

commandstring | nullableOptional

Windows client - Custom menu: The Command

Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
put
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

  • GETList
  • POSTCreate
  • GETGet
  • PUTUpdate
  • DELETEDelete

List

get

Retrieve information about a list of Themes.

Query parameters
NamestringOptional

Filter the result by Theme name (optional)

SiteIdinteger · int32Optional

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

Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/Theme HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-06-02T10:49:05.048Z",
    "timeLastMod": "2025-06-02T10:49:05.048Z",
    "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
  }
]

Create

post

Add a new Theme to a site.

Body

Create a new Theme

namestring | nullableRequired

Name of the new Theme policy.

descriptionstring | nullableOptional

Description for the new Theme policy.

Responses
201
Created
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
409
Conflict
application/json; api-version=1.0
post
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-06-02T10:49:05.048Z",
  "timeLastMod": "2025-06-02T10:49:05.048Z",
  "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
}