Themes

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
get
/api/Theme

Create

post

Add a new Theme to a site.

Body

Create a new Theme

namestring · min: 1 · max: 255 · nullableRequired

Name of the new Theme policy.

descriptionstring · nullableOptional

Description for the new Theme policy.

Responses
post
/api/Theme

Get

get

Retrieve a specific Theme by ID.

Path parameters
idinteger · int32Required

Theme ID

Responses
get
/api/Theme/{id}

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 · min: 1 · max: 255 · nullableOptional

General: The new name of the specified Theme

descriptionstring · max: 255 · 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 · min: 1 · max: 255 · nullableOptional

General: The domain used

groupEnabledboolean · nullableOptional

General: Whether to limit Themes to a certain group

postLogonMessagestring · max: 500 · nullableOptional

Messages: The post-logon message

loginPageURLPathstring · min: 1 · max: 255 · 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 · max: 255 · nullableOptional

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

webpageTitlestring · max: 255 · nullableOptional

User Portal - Branding: The Webpage Title

loginTostring · min: 1 · max: 255 · 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 · max: 500 · nullableOptional

User Portal - Messages: The Pre-Logon message

userPortalPostLogonMessagestring · max: 500 · nullableOptional

User Portal - Messages: The Post-Logon message

overridePostLogonMessageboolean · nullableOptional

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

loginHint_de_DEstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: German

passwordHint_de_DEstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: German

loginHint_en_USstring · min: 1 · max: 255 · nullableOptional

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

passwordHint_en_USstring · min: 1 · max: 255 · nullableOptional

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

loginHint_es_ESstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Spanish

passwordHint_es_ESstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Spanish

loginHint_fr_FRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: French

passwordHint_fr_FRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: French

loginHint_it_ITstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Italian

passwordHint_it_ITstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Italian

loginHint_ja_JPstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Japanese

passwordHint_ja_JPstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Japanese

loginHint_ko_KRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Korean

passwordHint_ko_KRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Korean

loginHint_nl_NLstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Dutch

passwordHint_nl_NLstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Dutch

loginHint_pt_BRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The User Prompt: Portuguese

passwordHint_pt_BRstring · min: 1 · max: 255 · nullableOptional

User Portal - Input prompt: The Password Prompt: Portuguese

loginHint_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

passwordHint_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

loginHint_zh_TWstring · min: 1 · max: 255 · nullableOptional

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

passwordHint_zh_TWstring · min: 1 · max: 255 · 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 · max: 255 · nullableOptional

Windows client - Branding: The Company Name

applicationNamestring · min: 1 · max: 255 · 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 · max: 500 · nullableOptional

Windows client - Messages: The post-logon message

menuItemstring · max: 255 · nullableOptional

Windows client - Custom menu: The Menu Item

commandstring · max: 255 · nullableOptional

Windows client - Custom menu: The Command

Responses
chevron-right
204

No Content

No content

put
/api/Theme/{id}

No content

Delete

delete

Delete a Theme from a site.

Path parameters
idinteger · int32Required

Theme ID

Responses
chevron-right
204

No Content

No content

delete
/api/Theme/{id}

No content

Was this helpful?