Get Appearance Configuration

Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a portal’s current appearance settings.

GetPortalAppearanceResponse

* Additional properties are NOT allowed.
theme_namestringrequired

Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.

Allowed values:mint_rocketdark_modecustom

Example:mint_rocket

custom_themeobject | nullrequired

Groups of variables for configuring visual details of the portal user interface. Set theme_name to ‘custom’ to use custom values for theme variables.

Example:{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}

* Additional properties are NOT allowed.
Show Child Parameters
custom_fontsobject | nullrequired

Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.

* Additional properties are NOT allowed.
Show Child Parameters
use_custom_fontsbooleanrequired

If true, fonts in custom_fonts will be used over the theme’s default fonts

textobject | nullrequired

Values to display for customizable text in the portal user interface

Example:{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}

* Additional properties are NOT allowed.
Show Child Parameters
imagesobject | nullrequired

A collection of binary image data to customize images in the portal

Example:{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/appearance
 
application/json

Update Appearance Configuration

Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a portal’s appearance settings

UpdatePortalAppearanceRequest

* Additional properties are NOT allowed.
theme_namestring

Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.

Allowed values:mint_rocketdark_modecustom

Example:mint_rocket

custom_themeobject | null

Groups of variables for configuring visual details of the portal user interface. Set theme_name to ‘custom’ to use custom values for theme variables.

Example:{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}

* Additional properties are NOT allowed.
Show Child Parameters
custom_fontsobject | null

Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.

* Additional properties are NOT allowed.
Show Child Parameters
use_custom_fontsboolean

If true, fonts in custom_fonts will be used over the theme’s default fonts

textobject | null

Values to display for customizable text in the portal user interface

Example:{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}

* Additional properties are NOT allowed.
Show Child Parameters
imagesobject | null

A collection of binary image data to customize images in the portal

Example:{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Details about the appearance settings being updated.

UpdatePortalAppearanceResponse

* Additional properties are NOT allowed.
theme_namestringrequired

Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.

Allowed values:mint_rocketdark_modecustom

Example:mint_rocket

custom_themeobject | nullrequired

Groups of variables for configuring visual details of the portal user interface. Set theme_name to ‘custom’ to use custom values for theme variables.

Example:{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}

* Additional properties are NOT allowed.
Show Child Parameters
custom_fontsobject | nullrequired

Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.

* Additional properties are NOT allowed.
Show Child Parameters
use_custom_fontsbooleanrequired

If true, fonts in custom_fonts will be used over the theme’s default fonts

textobject | nullrequired

Values to display for customizable text in the portal user interface

Example:{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}

* Additional properties are NOT allowed.
Show Child Parameters
imagesobject | nullrequired

A collection of binary image data to customize images in the portal

Example:{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}

* Additional properties are NOT allowed.
Show Child Parameters
patch/portals/{portalId}/appearance

Body

{ "theme_name": "custom", "use_custom_fonts": true, "custom_theme": { "colors": { "section": { "header": { "value": "#F8F8F8", "description": "Background for header" }, "body": { "value": "#FFFFFF", "description": "Background for main content" }, "hero": { "value": "#F8F8F8", "description": "Background for hero section" }, "accent": { "value": "#F8F8F8", "description": "Subtle background" }, "tertiary": { "value": "#FFFFFF", "description": "Tertiary background" }, "stroke": { "value": "rgba(0,0,0,0.1)", "description": "Border color" }, "footer": { "value": "#07A88D", "description": "Background for footer" } }, "text": { "header": { "value": "rgba(0,0,0,0.8)", "description": "Header text" }, "hero": { "value": "#FFFFFF", "description": "Hero text" }, "headings": { "value": "rgba(0,0,0,0.8)", "description": "Headings text" }, "primary": { "value": "rgba(0,0,0,0.8)", "description": "Main content text" }, "secondary": { "value": "rgba(0,0,0,0.8)", "description": "Supporting text" }, "accent": { "value": "#07A88D", "description": "Subtle text" }, "link": { "value": "#07A88D", "description": "Link text" }, "footer": { "value": "#FFFFFF", "description": "Footer text" } }, "button": { "primary_fill": { "value": "#1155CB", "description": "Background for Primary Button" }, "primary_text": { "value": "#FFFFFF", "description": "Text for Primary Button" } } } }, "custom_fonts": { "base": "Roboto", "code": "Roboto", "headings": "Roboto" }, "text": { "catalog": { "welcome_message": "Welcome", "primary_header": "Come one in!" } }, "images": { "favicon": { "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=", "filename": "favicon.ico" }, "logo": { "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=", "filename": "logo.png" }, "catalog_cover": { "data": "data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=" } } }
 
application/json

Get Portal Logo

Returns the portal logo or returns the default

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

Logo of the portal. Can be either png or jpg

GetPortalAppearanceLogoResponse

GetPortalAppearanceLogoResponsestring
get/portals/{portalId}/appearance/logo
 

Get Portal Catalog Cover

Returns the portal catalog cover or returns the default

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

Catalog Cover of the portal. Can be either png or jpg

GetPortalAppearanceLogoResponse

GetPortalAppearanceLogoResponsestring
get/portals/{portalId}/appearance/catalog-cover
 

Portal Product Versions

Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal.

They contain:

  • Lifecyle and deprecation statuses
  • Application registration settings like auto approve or whether application registration is enabled
  • The authentication strategy that is enabled for Application Registration