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.
Path Parameters
ID of the portal.
Body
application/json
Body
Update a portal’s appearance settings
UpdatePortalAppearanceRequest
Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.
Allowed values:mint_rocketdark_modecustom
Example:mint_rocket
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"}}}}
Show Child Parameters
Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.
Show Child Parameters
If true, fonts in custom_fonts will be used over the theme’s default fonts
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"}}
Show Child Parameters
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="}}
Show Child Parameters
Response
application/json
Response
Details about the appearance settings being updated.
UpdatePortalAppearanceResponse
Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.
Allowed values:mint_rocketdark_modecustom
Example:mint_rocket
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"}}}}
Show Child Parameters
Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.
Show Child Parameters
If true, fonts in custom_fonts will be used over the theme’s default fonts
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"}}
Show Child Parameters
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="}}
Show Child Parameters
Authentication
Path Parameters
Body
Get Portal Logo
Returns the portal logo or returns the default
Path Parameters
ID of the portal.
Response
Response
Logo of the portal. Can be either png or jpg
GetPortalAppearanceLogoResponse
Authentication
Path Parameters
Get Portal Catalog Cover
Returns the portal catalog cover or returns the default
Path Parameters
ID of the portal.
Response
Response
Catalog Cover of the portal. Can be either png or jpg
GetPortalAppearanceLogoResponse
Authentication
Path Parameters
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
List portal product versions
List portal product versions
Query Parameters
Sorts a collection of Portal Product Versions. Supported sort attributes are:
- created_at
- updated_at
- publish_status
- product_version_id
- auth_strategy_ids
- application_registration_enabled
- auto_approve_registration
- deprecated
Filters a collection of Portal Product Versions.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
ID of the portal.
Response
application/json
Response
A response containing a list of portal product versions
ListPortalProductVersions
A paginated list response for a collection of portal product versions
A Portal Product Version holds metadata that describes how a Product Version is configured for a specific portal.
It contains:
- Lifecyle and deprecation statuses
- Application registration settings like auto approve or whether application registration is enabled
- The Authentication Strategy (if present) that is enabled for Application Registration
Show Child Parameters
returns the pagination information