---
title: "Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-dev-3/versions/274bdb30-1594-4a78-9b53-4b3ca28797c0"
---

# Portal

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal","version":"2.0.0","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v2/portal":{"get":{"operationId":"get-portal-context","summary":"Get portal context","description":"Return the portal context object.","responses":{"200":{"$ref":"#/components/responses/GetPortalContextResponse"}},"security":[{}],"tags":["portal"]}},"/api/v2/portal/customization":{"get":{"operationId":"get-portal-customization","summary":"Get Customization","description":"Returns the customized portal appearance.","responses":{"200":{"$ref":"#/components/responses/GetPortalCustomization"}},"deprecated":true,"security":[{}],"tags":["portal"]}}},"components":{"schemas":{"PortalContext":{"description":"describe the portal execution context","type":"object","properties":{"portal_id":{"type":"string","format":"uuid"},"org_id":{"type":"string","format":"uuid"},"featureset_id":{"type":"string"},"feature_set":{"description":"String that determines feature set group developer belongs to when logged in","type":"string"},"basic_auth_enabled":{"description":"Whether the portal can be accessed via email and password","type":"boolean"},"oidc_auth_enabled":{"description":"Whether the portal can be accessed via authentication with Single Sign On (SSO) through OpenID Connect (OIDC) from a third-party Identity Provider","type":"boolean"},"saml_auth_enabled":{"description":"Whether the portal can be accessed via SAML authentication","type":"boolean"},"is_public":{"description":"Whether the portal catalog can be accessed by non-authenticated users","type":"boolean"},"rbac_enabled":{"description":"Whether the portal is protected with Role-Based Access Control","type":"boolean"},"dcr_provider_ids":{"description":"The unique identifiers of each available client provider when using Dynamic Client Registration","type":"array","items":{"type":"string","format":"uuid"}},"allowed_time_period":{"description":"Allowed time period for Analytics queries","type":"string"},"name":{"description":"Name of the developer portal.","type":"string"},"canonical_domain":{"description":"The canonical domain of the developer portal.","type":"string"}},"additionalProperties":false,"required":["canonical_domain","portal_id","org_id","is_public","featureset_id","basic_auth_enabled","oidc_auth_enabled","rbac_enabled","dcr_provider_ids","allowed_time_period","name"],"title":"Portal Context"},"PortalMenuItem":{"type":"object","properties":{"path":{"description":"The absolute path of a page in a portal with a leading slash.","type":"string","example":"/about/company","maxLength":512},"title":{"description":"The link display text","type":"string","example":"My Page"},"visibility":{"description":"Whether a menu item is public or private. Private menu items are only accessible to authenticated users.","type":"string","example":"public","enum":["public","private"]},"external":{"description":"When clicked, open the link in a new window","type":"boolean"}},"additionalProperties":false,"required":["path","title","visibility","external"]},"PortalFooterMenuSection":{"type":"object","properties":{"title":{"description":"The footer menu section title","type":"string","maxLength":512},"items":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}},"additionalProperties":false,"required":["title","items"]},"PortalCustomization":{"description":"The custom settings of this portal","type":"object","properties":{"theme":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":false},"mode":{"type":"string","enum":["light","dark","system"]},"colors":{"type":"object","additionalProperties":false,"properties":{"primary":{"type":"string","example":"#000000","nullable":false,"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","x-validation-message":"must be a valid hex color value"}}}}},"layout":{"type":"string","nullable":false},"css":{"type":"string","nullable":true},"js":{"type":"object","additionalProperties":false,"properties":{"custom":{"type":"string","nullable":true},"scripts":{"type":"array","items":{"type":"string","pattern":"^https://[^:.]+\\..+$"},"maxItems":20}}},"menu":{"type":"object","additionalProperties":false,"properties":{"main":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}},"footer_sections":{"type":"array","items":{"$ref":"#/components/schemas/PortalFooterMenuSection"}},"footer_bottom":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}}},"spec_renderer":{"type":"object","additionalProperties":false,"properties":{"try_it_ui":{"description":"Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.","type":"boolean","default":true},"try_it_insomnia":{"description":"Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.","type":"boolean","default":true},"infinite_scroll":{"description":"Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.","type":"boolean","default":true},"show_schemas":{"description":"Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.","type":"boolean","default":true},"hide_internal":{"description":"Manage visibility of internal endpoints and models.","type":"boolean","default":false},"hide_deprecated":{"description":"Manage visibility of deprecated endpoints and models.","type":"boolean","default":false},"allow_custom_server_urls":{"description":"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.","type":"boolean","default":true}}},"robots":{"type":"string","nullable":true}},"additionalProperties":false,"title":"PortalCustomization"}},"responses":{"GetPortalContextResponse":{"description":"portal context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalContext"}}}},"GetPortalCustomization":{"description":"Response for a portal customization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}}}},"tags":[{"name":"portal","description":"The API for retrieving details about a single Konnect Portal."}]}
```
