Get Customization

DEPRECATED

Returns the customized portal appearance.

get
/api/v2/portal/customization

Response

200 application/json

Response for a portal customization

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
200 application/json

Portal Context

object

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

saml_auth_enabledboolean

Whether the portal can be accessed via SAML authentication

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.

Example

PortalMenuItem

object
* Additional properties are NOT allowed.
pathstringrequired

The absolute path of a page in a portal with a leading slash.

<= 512 characters

Example:/about/company

titlestringrequired

The link display text

Example:My Page

visibilitystringrequired

Whether a menu item is public or private. Private menu items are only accessible to authenticated users.

Allowed values:publicprivate

Example:public

externalbooleanrequired

When clicked, open the link in a new window

Example

PortalFooterMenuSection

object
* Additional properties are NOT allowed.
titlestringrequired

The footer menu section title

<= 512 characters

itemsarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

PortalCustomization

object

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring
Example