Portal

object
* Additional properties are allowed.
idstring(uuid)required
namestringrequired
display_namestring
uristringrequired
custom_domainstring
is_domain_verifiedboolean
logostring
logo_filenamestring
faviconstring
favicon_filenamestring
is_publicboolean
authentication_enabledboolean
default_api_visibilitystring

Allowed values:publicprivate

default_page_visibilitystring

Allowed values:publicprivate

auto_approve_developersboolean
auto_approve_applicationsboolean
rbac_enabledboolean
configobject
* Additional properties are allowed.
versionstringrequired
customizationobject

The custom settings of this portal

* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

descriptionstring
default_application_auth_strategyobjectrequired
Show Child Parameters
sipr_enabledboolean

Whether ip allow list is enabled for the organization.

Default:false

Example:true

Example

ProductVersion

object
* Additional properties are NOT allowed.
idstring(uuid)required
Example

AuthStrategy

idstring(uuid)required
namestringrequired
display_namestringrequired
strategy_typestringrequired
configsobjectrequired
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobjectrequired
Show Child Parameters
Example

NullableAuthStrategy

idstring(uuid)required
namestringrequired
display_namestringrequired
strategy_typestringrequired
configsobjectrequired
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobjectrequired
Show Child Parameters
Example

BaseAuthStrategy

object
idstring(uuid)required
namestringrequired
display_namestringrequired
strategy_typestringrequired
configsobjectrequired
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobjectrequired
Show Child Parameters
Example