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

Content

The API for retrieving content for a Konnect Portal.

List Pages

Returns a tree view of pages for the portal. Each page has a slug, title, and content. The full tree is returned in one response; this endpoint is not paginated. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.

get
/api/v3/pages

Query Parameters

sortstring

Sorts a collection of portal pages. Supported sort attributes are:

  • created_at
  • updated_at
  • slug
  • title
  • visibility
filter[title][eq]string

Filter by direct equality comparison of the title property with a supplied value.

Example:Good Page

filter[title]string

Filter by direct equality comparison (short-hand) of the title property with a supplied value.

Example:Good Page

filter[title][contains]string

Filter by contains comparison of the title property with a supplied substring

Example:Good

filter[slug][eq]string

Filter by direct equality comparison of the slug property with a supplied value.

Example:good-page

filter[slug]string

Filter by direct equality comparison (short-hand) of the slug property with a supplied value.

Example:good-page

filter[slug][contains]string

Filter by contains comparison of the slug property with a supplied substring

Example:good

filter[visibility][eq]string

Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Allowed values:publicprivate

Example:public

filter[visibility]string

Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Allowed values:publicprivate

Example:private

Response

200 application/json

Tree of portal pages for the portal

ListPortalPages

Tree of pages for the portal (nested children). Not paginated.

* Additional properties are NOT allowed.
dataarray[object]required

A single page for the portal

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