2.0.0OAS 3.0

N/A (this description is removed during bundling)

API Base URL
Additional Information
Contact Kong

portal

The API for retrieving details about a single Konnect Portal.

Get portal context

Return the portal context object.

get
/api/v2/portal

Response

200 application/json

portal context

Portal Context

describe the portal execution context

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

String that determines feature set group developer belongs to when logged in

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

is_publicbooleanrequired

Whether the portal catalog can be accessed by non-authenticated users

rbac_enabledbooleanrequired

Whether the portal is protected with Role-Based Access Control

dcr_provider_idsarray[string](uuid)required

The unique identifiers of each available client provider when using Dynamic Client Registration

allowed_time_periodstringrequired

Allowed time period for Analytics queries

namestringrequired

Name of the developer portal.

canonical_domainstringrequired

The canonical domain of the developer portal.

200 application/json

Get Portal Appearance Details

Gets appearance configuration object for the portal. This object is set in Konnect.

get
/api/v2/portal/appearance

Response

200 application/json

portal appearance

Portal Appearance

the portal appearance

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

Get Portal Logo

Gets logo of the developer portal. This object is set in Konnect.

get
/api/v2/portal/logo

Response

200

Logo of the portal. Can be either png or jpg

string
200