Get Portal Context
Returns information about the portal.
Response
200 application/json
Response
The portal context object
PortalContext
Describes the portal execution context
ID of the portal
ID of the organization
Whether the portal can be accessed via email and password
Whether the portal can be accessed via authentication with Single Sign On (SSO) through OpenID Connect (OIDC) from a third-party Identity Provider
Whether the portal can be accessed via SAML authentication
Whether authentication is enabled for the portal
Whether Role-Based Access Control is enabled for the portal
Name of the developer portal
The canonical domain of the developer portal
Get Portal Customization Settings
Returns the portal’s custom settings.
Response
200 application/json
Response
Response for custom portal settings
PortalCustomization
The custom settings of this portal
Show Child Parameters
Show Child Parameters
Show Child Parameters
Get Portal Integration Configurations
Returns the portal’s integration configurations.
Response
200 application/json
Response
Response for portal integration configurations
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
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.
Query Parameters
Sorts a collection of portal pages. Supported sort attributes are:
- created_at
- updated_at
- slug
- title
- visibility
Filter by direct equality comparison of the title property with a supplied value.
Example:Good Page
Filter by direct equality comparison (short-hand) of the title property with a supplied value.
Example:Good Page
Filter by contains comparison of the title property with a supplied substring
Example:Good
Filter by direct equality comparison of the slug property with a supplied value.
Example:good-page
Filter by direct equality comparison (short-hand) of the slug property with a supplied value.
Example:good-page
Filter by contains comparison of the slug property with a supplied substring
Example:good
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 (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
Response
Tree of portal pages for the portal
ListPortalPages
Tree of pages for the portal (nested children). Not paginated.
A single page for the portal