Get Identity Provider
Retrieves the configuration of a single identity provider. This operation returns information about a
specific identity provider’s settings and authentication integration details.
Path Parameters
ID of the portal.
ID of the identity provider.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.
Identity Provider
The identity provider that contains configuration data for authentication integration.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Identity Provider
Updates the configuration of an existing identity provider. This operation allows modifications to be made
to an existing identity provider’s configuration.
Path Parameters
ID of the portal.
ID of the identity provider.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.
Identity Provider
The identity provider that contains configuration data for updating an authentication integration.
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
Response
application/json
Response
An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.
Identity Provider
The identity provider that contains configuration data for authentication integration.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete Identity Provider
Deletes an existing identity provider configuration. This operation removes a specific identity provider
from the portal.
Path Parameters
ID of the portal.
ID of the identity provider.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
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.
Response
application/json
Response
A set of built-in appearance settings for developer portals.
GetAppearanceDefaultsResponse
The built-in appearance settings available for portals.
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"}}}}}
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
Values to display for customizable text in the portal user interface