konnect.PortalCustomization

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args PortalCustomizationArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args PortalCustomizationArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args PortalCustomizationArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args PortalCustomizationArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args PortalCustomizationArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

PortalId string

The Portal identifier

Css string

Layout string

Menu PortalCustomizationMenu

Robots string

SpecRenderer PortalCustomizationSpecRenderer

Theme PortalCustomizationTheme

PortalId string

The Portal identifier

Css string

Layout string

Menu PortalCustomizationMenuArgs

Robots string

SpecRenderer PortalCustomizationSpecRendererArgs

Theme PortalCustomizationThemeArgs

portalId String

The Portal identifier

css String

layout String

menu PortalCustomizationMenu

robots String

specRenderer PortalCustomizationSpecRenderer

theme PortalCustomizationTheme

portalId string

The Portal identifier

css string

layout string

menu PortalCustomizationMenu

robots string

specRenderer PortalCustomizationSpecRenderer

theme PortalCustomizationTheme

portal_id str

The Portal identifier

css str

layout str

menu PortalCustomizationMenuArgs

robots str

spec_renderer PortalCustomizationSpecRendererArgs

theme PortalCustomizationThemeArgs

portalId String

The Portal identifier

css String

layout String

menu Property Map

robots String

specRenderer Property Map

theme Property Map

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

FooterBottoms List<PortalCustomizationMenuFooterBottom>

FooterSections List<PortalCustomizationMenuFooterSection>

Mains List<PortalCustomizationMenuMain>

FooterBottoms []PortalCustomizationMenuFooterBottom

FooterSections []PortalCustomizationMenuFooterSection

Mains []PortalCustomizationMenuMain

footerBottoms List<PortalCustomizationMenuFooterBottom>

footerSections List<PortalCustomizationMenuFooterSection>

mains List<PortalCustomizationMenuMain>

footerBottoms PortalCustomizationMenuFooterBottom[]

footerSections PortalCustomizationMenuFooterSection[]

mains PortalCustomizationMenuMain[]

footer_bottoms Sequence[PortalCustomizationMenuFooterBottom]

footer_sections Sequence[PortalCustomizationMenuFooterSection]

mains Sequence[PortalCustomizationMenuMain]

footerBottoms List<Property Map>

footerSections List<Property Map>

mains List<Property Map>

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external boolean

When clicked, open the link in a new window. Not Null

path string

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

title string

The link display text. Not Null

visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external bool

When clicked, open the link in a new window. Not Null

path str

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

title str

The link display text. Not Null

visibility str

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

Items List<PortalCustomizationMenuFooterSectionItem>

Not Null

Title string

The footer menu section title. Not Null

Items []PortalCustomizationMenuFooterSectionItem

Not Null

Title string

The footer menu section title. Not Null

items List<PortalCustomizationMenuFooterSectionItem>

Not Null

title String

The footer menu section title. Not Null

items PortalCustomizationMenuFooterSectionItem[]

Not Null

title string

The footer menu section title. Not Null

items Sequence[PortalCustomizationMenuFooterSectionItem]

Not Null

title str

The footer menu section title. Not Null

items List<Property Map>

Not Null

title String

The footer menu section title. Not Null

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external boolean

When clicked, open the link in a new window. Not Null

path string

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

title string

The link display text. Not Null

visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external bool

When clicked, open the link in a new window. Not Null

path str

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

title str

The link display text. Not Null

visibility str

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

External bool

When clicked, open the link in a new window. Not Null

Path string

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

Title string

The link display text. Not Null

Visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external boolean

When clicked, open the link in a new window. Not Null

path string

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

title string

The link display text. Not Null

visibility string

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external bool

When clicked, open the link in a new window. Not Null

path str

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

title str

The link display text. Not Null

visibility str

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

external Boolean

When clicked, open the link in a new window. Not Null

path String

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

title String

The link display text. Not Null

visibility String

Whether a menu item is public or private. Private menu items are only accessible to authenticated users. Not Null; must be one of ["public", "private"]

AllowCustomServerUrls bool

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

HideDeprecated bool

Manage visibility of deprecated endpoints and models. Default: false

HideInternal bool

Manage visibility of internal endpoints and models. Default: false

InfiniteScroll bool

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

ShowSchemas bool

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

TryItInsomnia bool

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

TryItUi bool

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

AllowCustomServerUrls bool

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

HideDeprecated bool

Manage visibility of deprecated endpoints and models. Default: false

HideInternal bool

Manage visibility of internal endpoints and models. Default: false

InfiniteScroll bool

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

ShowSchemas bool

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

TryItInsomnia bool

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

TryItUi bool

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

allowCustomServerUrls Boolean

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

hideDeprecated Boolean

Manage visibility of deprecated endpoints and models. Default: false

hideInternal Boolean

Manage visibility of internal endpoints and models. Default: false

infiniteScroll Boolean

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

showSchemas Boolean

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

tryItInsomnia Boolean

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

tryItUi Boolean

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

allowCustomServerUrls boolean

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

hideDeprecated boolean

Manage visibility of deprecated endpoints and models. Default: false

hideInternal boolean

Manage visibility of internal endpoints and models. Default: false

infiniteScroll boolean

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

showSchemas boolean

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

tryItInsomnia boolean

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

tryItUi boolean

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

allow_custom_server_urls bool

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

hide_deprecated bool

Manage visibility of deprecated endpoints and models. Default: false

hide_internal bool

Manage visibility of internal endpoints and models. Default: false

infinite_scroll bool

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

show_schemas bool

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

try_it_insomnia bool

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

try_it_ui bool

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

allowCustomServerUrls Boolean

Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved. Default: true

hideDeprecated Boolean

Manage visibility of deprecated endpoints and models. Default: false

hideInternal Boolean

Manage visibility of internal endpoints and models. Default: false

infiniteScroll Boolean

Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages. Default: true

showSchemas Boolean

Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints. Default: true

tryItInsomnia Boolean

Enables users to open the API spec in Insomnia to explore and send requests with the native client. Default: true

tryItUi Boolean

Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured. Default: true

Colors PortalCustomizationThemeColors

Mode string

must be one of ["light", "dark", "system"]

Name string

Colors PortalCustomizationThemeColors

Mode string

must be one of ["light", "dark", "system"]

Name string

colors PortalCustomizationThemeColors

mode String

must be one of ["light", "dark", "system"]

name String

colors PortalCustomizationThemeColors

mode string

must be one of ["light", "dark", "system"]

name string

colors PortalCustomizationThemeColors

mode str

must be one of ["light", "dark", "system"]

name str

colors Property Map

mode String

must be one of ["light", "dark", "system"]

name String

Primary string

Primary string

primary String

primary string

primary str

primary String