---
title: "Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99"
---

# Portal

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal","version":"3.3.1","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v3/portal":{"get":{"operationId":"get-portal-context","summary":"Get Portal Context","description":"Returns information about the portal.","responses":{"200":{"$ref":"#/components/responses/GetPortalContextResponse"}},"security":[{"portalAccessToken":[]},{}],"tags":["Portal"]}},"/api/v3/pages":{"get":{"operationId":"list-portal-pages","summary":"List Pages","description":"Returns a tree view of pages for the portal. Each page has a slug, title, and content. The full tree is returned in one response; this endpoint is not paginated. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.","parameters":[{"$ref":"#/components/parameters/SortPortalPages"},{"$ref":"#/components/parameters/FilterByTitleEquality"},{"$ref":"#/components/parameters/FilterByTitleEqualityShort"},{"$ref":"#/components/parameters/FilterByTitleContains"},{"$ref":"#/components/parameters/FilterBySlugEquality"},{"$ref":"#/components/parameters/FilterBySlugEqualityShort"},{"$ref":"#/components/parameters/FilterBySlugContains"},{"$ref":"#/components/parameters/FilterByVisibilityEquality"},{"$ref":"#/components/parameters/FilterByVisibilityEqualityShort"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalPagesResponse"}},"security":[{"portalAccessToken":[]},{}],"tags":["Content"]}},"/api/v3/pages/{pagePath}":{"get":{"operationId":"get-portal-page-by-name","summary":"Get a Page","description":"Returns a single page for the portal. Each page has a slug, title, and content. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.","parameters":[{"$ref":"#/components/parameters/pagePath"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalPageResponse"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["Content"]}},"/api/v3/snippets":{"get":{"operationId":"list-portal-snippets","summary":"List Snippets","description":"Returns a paginated list of snippets for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.","parameters":[{"$ref":"#/components/parameters/SortPortalSnippets"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByTitleEquality"},{"$ref":"#/components/parameters/FilterByTitleEqualityShort"},{"$ref":"#/components/parameters/FilterByTitleContains"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByVisibilityEquality"},{"$ref":"#/components/parameters/FilterByVisibilityEqualityShort"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalSnippetsResponse"}},"security":[{"portalAccessToken":[]},{}],"tags":["Content"]}},"/api/v3/snippets/{snippetName}":{"get":{"operationId":"get-portal-snippet-by-name","summary":"Get a Snippet","description":"Returns a single snippet for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.","parameters":[{"$ref":"#/components/parameters/snippetName"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalSnippetResponse"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["Content"]}},"/api/v3/customization":{"get":{"operationId":"get-portal-customization","summary":"Get Portal Customization Settings","description":"Returns the portal's custom settings.","responses":{"200":{"$ref":"#/components/responses/PortalCustomizationResponse"}},"security":[{}],"tags":["Portal"]}},"/api/v3/integrations":{"get":{"operationId":"get-portal-integrations","summary":"Get Portal Integration Configurations","description":"Returns the portal's integration configurations.","responses":{"200":{"$ref":"#/components/responses/PortalIntegrationsResponse"}},"security":[{}],"tags":["Portal"]}},"/api/v3/assets/logo":{"get":{"operationId":"get-portal-logo","summary":"Get Portal Logo","description":"Gets logo of the developer portal.","responses":{"200":{"$ref":"#/components/responses/PortalImageAssetResponse"}},"security":[{}],"tags":["Content"]}},"/api/v3/assets/favicon":{"get":{"operationId":"get-portal-favicon","summary":"Get Portal Favicon","description":"Gets favicon of the developer portal.","responses":{"200":{"$ref":"#/components/responses/PortalImageAssetResponse"}},"security":[{}],"tags":["Content"]}}},"components":{"parameters":{"FilterByNameEquality":{"name":"filter[name][eq]","description":"Filter by direct equality comparison of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByNameEqualityShort":{"name":"filter[name]","description":"Filter by direct equality comparison (short-hand) of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterBySlugContains":{"name":"filter[slug][contains]","description":"Filter by contains comparison of the slug property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"good"}},"FilterBySlugEquality":{"name":"filter[slug][eq]","description":"Filter by direct equality comparison of the slug property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good-page"}},"FilterBySlugEqualityShort":{"name":"filter[slug]","description":"Filter by direct equality comparison (short-hand) of the slug property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good-page"}},"FilterByTitleContains":{"name":"filter[title][contains]","description":"Filter by contains comparison of the title property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"Good"}},"FilterByTitleEquality":{"name":"filter[title][eq]","description":"Filter by direct equality comparison of the title property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"Good Page"}},"FilterByTitleEqualityShort":{"name":"filter[title]","description":"Filter by direct equality comparison (short-hand) of the title property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"Good Page"}},"FilterByVisibilityEquality":{"name":"filter[visibility][eq]","description":"Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.","in":"query","required":false,"schema":{"type":"string","example":"public","enum":["public","private"]}},"FilterByVisibilityEqualityShort":{"name":"filter[visibility]","description":"Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.","in":"query","required":false,"schema":{"type":"string","example":"private","enum":["public","private"]}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"pagePath":{"name":"pagePath","in":"path","required":true,"description":"Targeted page, url-encoded.","example":"%2Fmypage","schema":{"type":"string"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"snippetName":{"name":"snippetName","in":"path","required":true,"description":"Targeted snippet, url-encoded. Must not start with /.","example":"mysnippet","schema":{"type":"string"}},"SortPortalPages":{"name":"sort","description":"Sorts a collection of portal pages. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - slug\n  - title\n  - visibility\n","in":"query","required":false,"schema":{"type":"string"}},"SortPortalSnippets":{"name":"sort","description":"Sorts a collection of portal snippets. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - name\n  - title\n  - visibility\n","in":"query","required":false,"schema":{"type":"string"}}},"schemas":{"PortalContext":{"description":"Describes the portal execution context","type":"object","properties":{"portal_id":{"description":"ID of the portal","type":"string","format":"uuid"},"org_id":{"description":"ID of the organization","type":"string","format":"uuid"},"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"},"authentication_enabled":{"description":"Whether authentication is enabled for the portal","type":"boolean"},"rbac_enabled":{"description":"Whether Role-Based Access Control is enabled for the portal","type":"boolean"},"name":{"description":"Name of the developer portal","type":"string"},"canonical_domain":{"description":"The canonical domain of the developer portal","type":"string"}},"additionalProperties":false,"required":["portal_id","org_id","basic_auth_enabled","oidc_auth_enabled","saml_auth_enabled","authentication_enabled","rbac_enabled","name","canonical_domain"],"title":"PortalContext"},"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},"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"},"PortalIntegrations":{"description":"Configuration data for Dev Portal integrations","type":"object","properties":{"google_tag_manager":{"$ref":"#/components/schemas/GoogleTagManagerIntegration"},"google_analytics_4":{"$ref":"#/components/schemas/GoogleAnalytics4Integration"}},"default":{},"additionalProperties":false,"title":"Portal Integrations"},"PageId":{"description":"The unique identifier of the page","type":"string","format":"uuid","example":"582b9327-3eba-4bfe-9438-6066840dbbca","title":"PageId"},"PageSlug":{"description":"The slug of the page.","type":"string","example":"/my-page","title":"PageSlug"},"PageTitle":{"description":"The title of the page","type":"string","example":"My Page","title":"PageTitle"},"PageContent":{"description":"The renderable markdown content of the page","type":"string","example":"# Welcome to the Developer Portal","title":"PageContent"},"Visibility":{"description":"Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.","type":"string","example":"public","enum":["public","private"],"title":"Resource Public Visibility"},"Description":{"type":"string","example":"A custom page about developer portals","title":"ResourceDescription"},"SnippetId":{"description":"The unique identifier of the snippet","type":"string","format":"uuid","example":"582b9327-3eba-4bfe-9438-6066840dbbcb","title":"SnippetId"},"SnippetTitle":{"description":"The title of the snippet","type":"string","example":"My Snippet","title":"SnippetTitle"},"SnippetContent":{"description":"The renderable markdown content of the snippet","type":"string","example":"# Welcome to the Developer Portal","title":"SnippetContent"},"SnippetName":{"description":"The name of the snippet (no leading slash)","type":"string","example":"my-snippet","title":"SnippetName"},"ListPortalPages":{"description":"Tree of pages for the portal (nested `children`). Not paginated.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalPageInfo"}}},"additionalProperties":false,"required":["data"],"title":"ListPortalPages"},"ListPortalSnippets":{"description":"A paginated list of snippets for the portal","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalSnippetInfo"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"title":"ListPortalSnippets"},"PortalPageInfo":{"description":"A single page for the portal","type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"slug":{"$ref":"#/components/schemas/PageSlug"},"title":{"$ref":"#/components/schemas/PageTitle"},"visibility":{"$ref":"#/components/schemas/Visibility"},"description":{"$ref":"#/components/schemas/Description"},"parent_page_id":{"$ref":"#/components/schemas/ParentPageId"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"children":{"description":"children of the page","type":"array","items":{"$ref":"#/components/schemas/PortalPageInfo"},"example":[{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","slug":"hello-world","title":"Hello world","visibility":"public","parent_page_id":null,"children":[]}]}},"additionalProperties":false,"required":["id","slug","title","visibility","created_at","updated_at","children","parent_page_id"],"title":"PortalPageInfo"},"PortalSnippetInfo":{"description":"A single snippet for the portal","type":"object","properties":{"id":{"$ref":"#/components/schemas/SnippetId"},"name":{"$ref":"#/components/schemas/SnippetName"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"visibility":{"$ref":"#/components/schemas/Visibility"},"description":{"$ref":"#/components/schemas/Description"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","title","visibility","created_at","updated_at"],"title":"PortalSnippetInfo"},"PortalPage":{"description":"A single page for the portal","type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"title":{"$ref":"#/components/schemas/PageTitle"},"slug":{"$ref":"#/components/schemas/PageSlug"},"content":{"$ref":"#/components/schemas/PageContent"},"visibility":{"$ref":"#/components/schemas/Visibility"},"description":{"$ref":"#/components/schemas/Description"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"parent_page_id":{"$ref":"#/components/schemas/ParentPageId"}},"additionalProperties":false,"required":["id","title","slug","content","visibility","created_at","updated_at","parent_page_id"],"title":"PortalPage"},"ParentPageId":{"description":"Pages may be rendered as a tree of files.\n","type":"string","format":"uuid","nullable":true},"PortalSnippet":{"description":"A single snippet for the portal","type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"name":{"$ref":"#/components/schemas/SnippetName"},"content":{"$ref":"#/components/schemas/SnippetContent"},"visibility":{"$ref":"#/components/schemas/Visibility"},"description":{"$ref":"#/components/schemas/Description"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","title","name","content","visibility","created_at","updated_at"],"title":"PortalSnippet"},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"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"]},"GoogleTagManagerIntegration":{"description":"Google Tag Manager integration configuration","type":"object","properties":{"enabled":{"description":"Whether the integration is enabled","type":"boolean"},"type":{"description":"The type of the integration for categorization","type":"string","enum":["tracking"]},"config_data":{"description":"Configuration data for the Google Tag Manager integration","type":"object","additionalProperties":false,"properties":{"id":{"description":"The Google Tag Manager container ID","type":"string","example":"GTM-XXXXXX","maxLength":20,"minLength":5,"pattern":"^GTM-[A-Za-z0-9]+$","x-validation-message":"must be a valid GTM container ID (format: GTM-XXXXXX)"},"l":{"description":"Optional dataLayer variable name","type":"string","example":"myNewName","maxLength":100,"nullable":true},"preview":{"description":"Preview environment name","type":"string","example":"preview","maxLength":100,"nullable":true},"cookies_win":{"description":"Forces GTM cookies to take precedence when true","type":"boolean","nullable":true},"debug":{"description":"Enables debug mode when true","type":"boolean","nullable":true},"npa":{"description":"No Personal Advertising - disables advertising features when true","type":"boolean","nullable":true},"data_layer":{"description":"Custom dataLayer name (alternative to \"l\" property)","type":"string","example":"myNewName","maxLength":100,"nullable":true},"env_name":{"description":"Environment name for environment-specific container","type":"string","example":"production","maxLength":100,"nullable":true},"auth_referrer_policy":{"description":"Referrer policy for analytics requests","type":"string","example":"no-referrer","maxLength":100,"nullable":true}},"required":["id"]}},"additionalProperties":false,"nullable":true,"required":["enabled","type","config_data"]},"GoogleAnalytics4Integration":{"description":"Google Analytics integration configuration","type":"object","properties":{"enabled":{"description":"Whether the integration is enabled","type":"boolean"},"type":{"description":"The type of the integration for categorization","type":"string","enum":["analytics"]},"config_data":{"description":"Configuration data for the Google Analytics integration","type":"object","additionalProperties":false,"properties":{"id":{"description":"The Google Analytics measurement ID","type":"string","example":"G-XXXXXXX","maxLength":20,"minLength":5,"pattern":"^G-[A-Za-z0-9-]+$","x-validation-message":"must be a valid Google Analytics ID (format: G-XXXXXXX)"},"l":{"description":"The datalayer's name you want data to be associated with","type":"string","example":"myNewName","maxLength":100,"nullable":true}},"required":["id"]}},"additionalProperties":false,"nullable":true,"required":["enabled","type","config_data"]}},"examples":{"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"ListPortalPagesResponse":{"description":"Tree of portal pages for the portal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalPages"},"examples":{"ListPortalPageResponseExample1":{"value":{"data":[{"id":"582b9327-3eba-4bfe-9438-6066840dbbca","title":"Home","slug":"/","visibility":"public","description":"Welcome page","parent_page_id":null,"children":[],"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}]}}}}}},"ListPortalSnippetsResponse":{"description":"Paginated list of portal snippets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalSnippets"},"examples":{"ListPortalSnippetResponseExample1":{"value":{"data":[{"id":"582b9327-3eba-4bfe-9438-6066840dbbca","title":"Home","name":"snip1","visibility":"public","description":"Welcome snippet","created_at":"2021-09-01T00:00:00Z","updated_at":"2021-09-01T00:00:00Z"}],"meta":{"page":{"size":10,"total":1,"number":1}}}}}}}},"GetPortalPageResponse":{"description":"A single portal page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalPage"},"examples":{"PortalPageResponseExample1":{"value":{"id":"582b9327-3eba-4bfe-9438-6066840dbbca","title":"Home","slug":"/","content":"# Welcome to the Developer Portal","visibility":"public","parent_page_id":null,"created_at":"2021-09-01T00:00:00Z","updated_at":"2021-09-01T00:00:00Z"}}}}}},"GetPortalSnippetResponse":{"description":"A single portal snippet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSnippet"},"examples":{"PortalPageResponseExample1":{"value":{"id":"582b9327-3eba-4bfe-9438-6066840dbbca","title":"Home","name":"snip1","content":"# Welcome to the Developer Portal","visibility":"public","created_at":"2021-09-01T00:00:00Z","updated_at":"2021-09-01T00:00:00Z"}}}}}},"GetPortalContextResponse":{"description":"The portal context object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalContext"},"examples":{"GetPortalContextResponseExample1":{"value":{"portal_id":"18a9b697-7e68-411b-8e1d-102b261ab18e","org_id":"a40f5d1f-d889-42e9-94ea-b9b33585fc6b","basic_auth_enabled":true,"oidc_auth_enabled":true,"saml_auth_enabled":true,"authentication_enabled":true,"rbac_enabled":true,"name":"my portal","canonical_domain":"portal.example.com"}}}}}},"PortalImageAssetResponse":{"description":"An image asset","content":{"image/jpg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"PortalCustomizationResponse":{"description":"Response for custom portal settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}},"PortalIntegrationsResponse":{"description":"Response for portal integration configurations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIntegrations"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"Portal","description":"The API for retrieving details about a single Konnect Portal."},{"name":"Content","description":"The API for retrieving content for a Konnect Portal."}]}
```
