3.3.1OAS 3.0

N/A (this description is removed during bundling)

API Base URL
Security
portalAccessToken (apiKey)

The Developer portal cookie is meant to be used by the Developer API to authenticate with.

Additional Information
Contact Kong

Portal

The API for retrieving details about a single Konnect Portal.

Get Portal Context

Returns information about the portal.

get
/api/v3/portal

Response

200 application/json

The portal context object

PortalContext

Describes the portal execution context

* Additional properties are NOT allowed.
portal_idstring(uuid)required

ID of the portal

org_idstring(uuid)required

ID of the organization

basic_auth_enabledbooleanrequired

Whether the portal can be accessed via email and password

oidc_auth_enabledbooleanrequired

Whether the portal can be accessed via authentication with Single Sign On (SSO) through OpenID Connect (OIDC) from a third-party Identity Provider

saml_auth_enabledbooleanrequired

Whether the portal can be accessed via SAML authentication

authentication_enabledbooleanrequired

Whether authentication is enabled for the portal

rbac_enabledbooleanrequired

Whether Role-Based Access Control is enabled for the portal

namestringrequired

Name of the developer portal

canonical_domainstringrequired

The canonical domain of the developer portal

200 application/json

Get Portal Customization Settings

Returns the portal’s custom settings.

get
/api/v3/customization

Response

200 application/json

Response for custom portal settings

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
200 application/json

Get Portal Integration Configurations

Returns the portal’s integration configurations.

get
/api/v3/integrations

Response

200 application/json

Response for portal integration configurations

Portal Integrations

Configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Google Tag Manager integration configuration

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

Google Analytics integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
200 application/json