PortalContext
objectDescribes 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
Example
PortalCustomization
objectThe custom settings of this portal
* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring
Example
Portal Integrations
objectConfiguration data for Dev Portal integrations
Default:{}
* Additional properties are NOT allowed.
google_tag_managerobject
Google Tag Manager integration configuration
* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object
Google Analytics integration configuration
* Additional properties are NOT allowed.
Show Child Parameters
Example
PageId
stringThe unique identifier of the page
Example
PageSlug
stringThe slug of the page.
Example