Get Customization

Returns the portal customization options.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

The current customization options for a portal.

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
get/portals/{portalId}/customization
 
application/json

Replace Customization

Replace the portal customization options.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null

Response

application/json

The current customization options for a portal.

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
put/portals/{portalId}/customization

Body

{}
 
application/json

Update Customization

Update the portal customization options, merging properties.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null

Response

application/json

The current customization options for a portal.

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
patch/portals/{portalId}/customization

Body

{}
 
application/json

Portal Auth Settings

APIs related to configuration of Konnect Developer Portal auth settings.

Get Auth Settings

Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a portal’s authentication settings.

PortalAuthenticationSettingsResponse

The developer authentication settings for a portal.

basic_auth_enabledbooleanrequired

The portal has basic auth enabled or disabled.

Example:true

oidc_auth_enabledbooleanrequiredDEPRECATED

The portal has OIDC enabled or disabled.

Example:false

saml_auth_enabledbooleanDEPRECATED

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_team_mapping_enabledbooleanrequiredDEPRECATED

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

Example:true

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

Example:true

konnect_mapping_enabledbooleanrequired

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_configobjectread-onlyDEPRECATED

Configuration properties for an OpenID Connect Identity Provider.

Example:{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}

Show Child Parameters
get/portals/{portalId}/authentication-settings
 
application/json