---
title: "Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/f312f74b-fa65-4573-b3a5-637b8a51ae20"
---

# 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/appearance":{"get":{"operationId":"get-portal-appearance","summary":"Get Portal Appearance Details","description":"Gets appearance configuration object for the portal. This object is set in Konnect.","responses":{"200":{"$ref":"#/components/responses/GetPortalAppearanceResponse"}},"security":[{}],"tags":["portal"]}},"/api/v2/portal/logo":{"get":{"operationId":"get-portal-logo","summary":"Get Portal Logo","description":"Gets logo of the developer portal. This object is set in Konnect.","responses":{"200":{"$ref":"#/components/responses/GetPortalLogoResponse"}},"security":[{}],"tags":["portal"]}},"/api/v2/portal/catalog-cover":{"get":{"operationId":"get-portal-catalog-cover","summary":"Get Portal Catalog Cover Banner","description":"Gets cover banner for the developer portal. This object is set in Konnect.","responses":{"200":{"$ref":"#/components/responses/GetPortalCoverResponse"}},"security":[{}],"tags":["portal"]}}},"components":{"schemas":{"PortalAppearance":{"description":"the portal appearance","type":"object","properties":{"variables":{"type":"object","properties":{"catalog":{"type":"object","properties":{"logo":{"type":"object","properties":{"url":{"type":"string"}}},"cover":{"type":"object","properties":{"url":{"type":"string"}}},"primary_header":{"type":"object","properties":{"text":{"type":"string"}}},"welcome_message":{"type":"object","properties":{"text":{"type":"string"}}}}}}},"stylesheets":{"type":"object","properties":{"global":{"type":"object","properties":{"main":{"type":"object","properties":{"data":{"type":"object"}}}}}}}},"additionalProperties":false,"title":"Portal Appearance"},"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"},"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"}},"responses":{"GetPortalLogoResponse":{"description":"Logo of the portal. Can be either png or jpg","content":{"image/jpg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"GetPortalCoverResponse":{"description":"Cover of the portal. Can be either png or jpg","content":{"image/jpg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"GetPortalAppearanceResponse":{"description":"portal appearance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAppearance"}}}},"GetPortalContextResponse":{"description":"portal context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalContext"}}}}}},"tags":[{"name":"portal","description":"The API for retrieving details about a single Konnect Portal."}]}
```
