Delete Identity Provider

Deletes an existing identity provider configuration. This operation removes a specific identity provider
from the portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/portals/{portalId}/identity-providers/{id}
 

Portal Appearance

APIs related to Konnect Developer Portal Appearance Settings.

Get Default Appearance Configurations

Returns the built-in portal appearance configurations including pre-defined themes, colors, and font settings.

get

Response

application/json

A set of built-in appearance settings for developer portals.

GetAppearanceDefaultsResponse

The built-in appearance settings available for portals.

* Additional properties are NOT allowed.
themesobjectrequiredread-only

The set of built-in appearance themes that are provided for portals.

Example:{"mint_rocket":{"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"}}}},"dark_mode":{"colors":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","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
fontsobjectrequired

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
textobjectrequired

Values to display for customizable text in the portal user interface

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/appearance-defaults
 
application/json

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