---
title: "Portal Management V3"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e"
---

# Portal Management V3

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Portal Management V3","version":"3.4.1","description":"The management API for Portals","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v3","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v3","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v3","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v3","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v3","description":"India Production region"},{"url":"https://sg.api.konghq.com/v3","description":"Singapore Production region"}],"paths":{"/portals":{"get":{"operationId":"list-portals","summary":"List Portals","description":"Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortPortals"},{"name":"filter","in":"query","description":"Filter portals returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/PortalFilterParameters"},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalsResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListPortalsBadRequestExample1":{"$ref":"#/components/examples/ListPortalsBadRequestExample1"},"ListPortalsBadRequestExample2":{"$ref":"#/components/examples/ListPortalsBadRequestExample2"},"ListPortalsBadRequestExample3":{"$ref":"#/components/examples/ListPortalsBadRequestExample3"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portals"]},"post":{"operationId":"create-portal","summary":"Create Portal","description":"Creates a new developer portal scoped in this region for this organization.","requestBody":{"$ref":"#/components/requestBodies/CreatePortal"},"responses":{"201":{"$ref":"#/components/responses/PortalResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalBadRequestExample1"},"UpdatePortalBadRequestExample2":{"$ref":"#/components/examples/UpdatePortalBadRequestExample2"},"UpdatePortalBadRequestExample3":{"$ref":"#/components/examples/UpdatePortalBadRequestExample3"},"UpdatePortalBadRequestExample4":{"$ref":"#/components/examples/UpdatePortalBadRequestExample4"},"UpdatePortalBadRequestExample5":{"$ref":"#/components/examples/UpdatePortalBadRequestExample5"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portals"]}},"/portals/{portalId}":{"parameters":[{"name":"portalId","in":"path","description":"ID of the portal.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"get-portal","summary":"Get a Portal","description":"Returns the configuration for a single developer portal, including the current visibility, access, and domain settings.","responses":{"200":{"$ref":"#/components/responses/PortalResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals"]},"patch":{"operationId":"update-portal","summary":"Update Portal","description":"Updates the configuration for a single portal including the visibility, access, and custom domain settings.","requestBody":{"$ref":"#/components/requestBodies/UpdatePortal"},"responses":{"200":{"$ref":"#/components/responses/PortalResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalBadRequestExample1"},"UpdatePortalBadRequestExample2":{"$ref":"#/components/examples/UpdatePortalBadRequestExample2"},"UpdatePortalBadRequestExample3":{"$ref":"#/components/examples/UpdatePortalBadRequestExample3"},"UpdatePortalBadRequestExample4":{"$ref":"#/components/examples/UpdatePortalBadRequestExample4"},"UpdatePortalBadRequestExample5":{"$ref":"#/components/examples/UpdatePortalBadRequestExample5"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portals"]},"delete":{"operationId":"delete-portal","summary":"Delete Portal","description":"Deletes a single portal, along with all related entities.","parameters":[{"name":"force","in":"query","description":"If true, the portal will be deleted, automatically deleting all API publications. If the force param is not set, the deletion will only succeed if there are no APIs currently published.","schema":{"type":"string","default":"false","enum":["true","false"]}}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals"]}},"/portals/{portalId}/custom-domain":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-custom-domain","summary":"Get Custom Domain","description":"Get the custom domain associated to the portal.","responses":{"200":{"$ref":"#/components/responses/PortalCustomDomain"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Custom Domains"]},"post":{"operationId":"create-portal-custom-domain","summary":"Create Custom Domain","description":"Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.","requestBody":{"$ref":"#/components/requestBodies/CreatePortalCustomDomain"},"responses":{"201":{"$ref":"#/components/responses/PortalCustomDomain"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Custom Domains"]},"patch":{"operationId":"update-portal-custom-domain","summary":"Enable or Disable Domain","description":"Updates the portal domain associated with the portal.","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalCustomDomain"},"responses":{"200":{"$ref":"#/components/responses/PortalCustomDomain"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Custom Domains"]},"delete":{"operationId":"delete-portal-custom-domain","summary":"Remove Domain","description":"Deletes the custom domain associated with the portal.","responses":{"204":{"description":"No Content"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Custom Domains"]}},"/portals/{portalId}/assets/logo":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-asset-logo","summary":"Get Logo","description":"Returns the logo of the portal.","responses":{"200":{"$ref":"#/components/responses/PortalAssetResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]},"put":{"operationId":"replace-portal-asset-logo","summary":"Replace Logo","description":"Replaces the logo of the portal.","requestBody":{"$ref":"#/components/requestBodies/ReplacePortalImageAsset"},"responses":{"200":{"$ref":"#/components/responses/PortalAssetResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalImageAssetBadRequestExample1":{"$ref":"#/components/examples/ReplacePortalImageAssetBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]}},"/portals/{portalId}/assets/logo/raw":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-asset-logo-raw","summary":"Get Logo (Raw)","description":"Returns the raw logo of the portal.","responses":{"200":{"$ref":"#/components/responses/PortalAssetResponseRaw"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]}},"/portals/{portalId}/assets/favicon":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-asset-favicon","summary":"Get Favicon","description":"Returns the favicon of the portal.","responses":{"200":{"$ref":"#/components/responses/PortalAssetResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]},"put":{"operationId":"replace-portal-asset-favicon","summary":"Replace Favicon","description":"Replaces the favicon of the portal. The favicon is used in the browser tab of the portal.","requestBody":{"$ref":"#/components/requestBodies/ReplacePortalImageAsset"},"responses":{"200":{"$ref":"#/components/responses/PortalAssetResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalImageAssetBadRequestExample1":{"$ref":"#/components/examples/ReplacePortalImageAssetBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]}},"/portals/{portalId}/assets/favicon/raw":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-asset-favicon-raw","summary":"Get Favicon (Raw)","description":"Returns the raw favicon of the portal.","responses":{"200":{"$ref":"#/components/responses/PortalAssetResponseRaw"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Assets"]}},"/portals/{portalId}/customization":{"get":{"operationId":"get-portal-customization","summary":"Get Customization","description":"Returns the portal customization options.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/PortalCustomizationResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]},"put":{"operationId":"replace-portal-customization","summary":"Replace Customization","description":"Replace the portal customization options.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/ReplacePortalCustomization"},"responses":{"200":{"$ref":"#/components/responses/PortalCustomizationResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalCustomizationBadRequestExample1":{"$ref":"#/components/examples/ReplacePortalCustomizationBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]},"patch":{"operationId":"update-portal-customization","summary":"Update Customization","description":"Update the portal customization options, merging properties.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/ReplacePortalCustomization"},"responses":{"200":{"$ref":"#/components/responses/PortalCustomizationResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalCustomizationBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalCustomizationBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]}},"/portals/{portalId}/integrations":{"get":{"operationId":"get-portal-integrations","summary":"Get Portal Integration Configurations","description":"Returns the portal integration configurations.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/PortalIntegrationsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Integrations"]},"put":{"operationId":"upsert-portal-integrations","summary":"Replace Integration Configurations","description":"Replace the portal integration configurations.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/ReplacePortalIntegrations"},"responses":{"200":{"$ref":"#/components/responses/PortalIntegrationsResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalIntegrationsBadRequestExample1":{"$ref":"#/components/examples/ReplacePortalIntegrationsBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Integrations"]},"patch":{"operationId":"update-portal-integrations","summary":"Update Integration Configurations","description":"Update the portal integration configurations, merging properties.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdatePortalIntegrations"},"responses":{"200":{"$ref":"#/components/responses/PortalIntegrationsResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ReplacePortalIntegrationsBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalIntegrationsBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Integrations"]}},"/portals/{portalId}/pages":{"get":{"operationId":"list-portal-pages","summary":"List Pages","description":"Returns the tree view of custom pages that have been created for this portal. The full tree is returned in one response; this endpoint is not paginated.","parameters":[{"$ref":"#/components/parameters/SortPortalPages"},{"$ref":"#/components/parameters/PortalId"},{"name":"filter","in":"query","description":"Filter pages returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/PortalPagesFilterParameters"},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalPages"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListPortalPagesBadRequestExample1":{"$ref":"#/components/examples/ListPortalPagesBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]},"post":{"operationId":"create-portal-page","summary":"Create Page","description":"Creates a new custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in frontmatter will take precedence.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/CreatePortalPage"},"responses":{"201":{"$ref":"#/components/responses/PortalPage"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalPageBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample1"},"UpdatePortalPageBadRequestExample2:":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]}},"/portals/{portalId}/pages/{pageId}":{"get":{"operationId":"get-portal-page","summary":"Get a Page","description":"Returns the configuration of a single custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageId"}],"responses":{"200":{"$ref":"#/components/responses/PortalPage"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]},"patch":{"operationId":"update-portal-page","summary":"Update Page","description":"Updates the configuration of a single custom page for this portal.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdatePortalPage"},"responses":{"200":{"$ref":"#/components/responses/PortalPage"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalPageBadRequestExample1:":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample1"},"UpdatePortalPageBadRequestExample2:":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]},"delete":{"operationId":"delete-portal-page","summary":"Delete Page","description":"Deletes a single custom page for this portal.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageId"}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]}},"/portals/{portalId}/pages/{pageId}/move":{"post":{"operationId":"move-portal-pages","summary":"Move Page","description":"This api allows the user to move a page within the page tree using the parameters parent_page_id and index. If parent_page_id is not provided, the page will be placed at the top level of the page tree. index represents a zero-indexed page order relative to its siblings under the same parent. For example, if we want to put the page at top level in first position we would send parent_page_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the page list, which means you can put the page in last position by using index: -1.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageId"}],"requestBody":{"$ref":"#/components/requestBodies/MovePage"},"responses":{"201":{"description":"The document has been moved"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Pages"]}},"/portals/{portalId}/snippets":{"get":{"operationId":"list-portal-snippets","summary":"List Snippets","description":"Returns the paginated list of custom snippets that have been created for this portal.","parameters":[{"$ref":"#/components/parameters/SortPortalSnippets"},{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter snippets returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/PortalSnippetsFilterParameters"},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalSnippets"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListPortalSnippetsBadRequestExample1":{"$ref":"#/components/examples/ListPortalSnippetsBadRequestExample1"},"ListPortalSnippetsBadRequestExample2":{"$ref":"#/components/examples/ListPortalSnippetsBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Snippets"]},"post":{"operationId":"create-portal-snippet","summary":"Create Snippet","description":"Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the frontmatter will take precedence.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/CreatePortalSnippet"},"responses":{"201":{"$ref":"#/components/responses/PortalSnippet"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalPageBadRequestExample1":{"$ref":"#/components/examples/UpdatePortalSnippetBadRequestExample1"},"UpdatePortalSnippetBadRequestExample2":{"$ref":"#/components/examples/UpdatePortalSnippetBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Snippets"]}},"/portals/{portalId}/snippets/{snippetId}":{"get":{"operationId":"get-portal-snippet","summary":"Get a Snippet","description":"Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/SnippetId"}],"responses":{"200":{"$ref":"#/components/responses/PortalSnippet"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Snippets"]},"patch":{"operationId":"update-portal-snippet","summary":"Update Snippet","description":"Updates the configuration of a single custom snippet for this portal.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/SnippetId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdatePortalSnippet"},"responses":{"200":{"$ref":"#/components/responses/PortalSnippet"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdatePortalPageBadRequestExample1:":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample1"},"UpdatePortalPageBadRequestExample2:":{"$ref":"#/components/examples/UpdatePortalPageBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Snippets"]},"delete":{"operationId":"delete-portal-snippet","summary":"Delete Snippet","description":"Deletes a single custom snippet for this portal.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/SnippetId"}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Snippets"]}},"/portals/{portalId}/default-content":{"post":{"operationId":"create-default-content","summary":"Create Boilerplate Content","description":"Creates a default collection of pages, snippets, and customization config for a portal if they do not already exist. This endpoint is optional, you can call it to populate a newly created developer portal with default content, but it is not required. Existing pages and snippets will not be modified or deleted. If used, it is typically called once per portal shortly after creation.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"201":{"$ref":"#/components/responses/DefaultContentResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Pages"]}},"/portals/{portalId}/applications":{"get":{"operationId":"list-applications","summary":"List Applications","description":"Lists applications in this portal. Each application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider's application by its `client_id`.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortApplications"},{"name":"filter","in":"query","description":"Filter applications returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/FilterApplications"},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListApplications"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListApplicationsBadRequestExample1":{"$ref":"#/components/examples/ListApplicationsBadRequestExample1"},"ListApplicationsBadRequestExample2":{"$ref":"#/components/examples/ListApplicationsBadRequestExample2"},"ListApplicationsBadRequestExample3":{"$ref":"#/components/examples/ListApplicationsBadRequestExample3"},"ListApplicationsBadRequestExample4":{"$ref":"#/components/examples/ListApplicationsBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]}},"/portals/{portalId}/applications/{applicationId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"get":{"operationId":"get-application","summary":"Get an Application by Portal","description":"Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the `dcr_provider.id` and `client_id` can be used to correlate it. An application manages a set of credentials and registrations for specific APIs.","responses":{"200":{"$ref":"#/components/responses/GetApplication"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]},"patch":{"operationId":"update-application","summary":"Update Application","description":"Updates an application.","requestBody":{"$ref":"#/components/requestBodies/UpdateApplication"},"responses":{"200":{"$ref":"#/components/responses/GetApplication"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]},"delete":{"operationId":"delete-application","summary":"Delete Application by Portal","description":"Delete a single application in this portal, along with its registrations and credentials.","responses":{"204":{"description":"The application has been deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]}},"/portals/{portalId}/applications/{applicationId}/developers":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"get":{"operationId":"list-developers-by-application","summary":"List Developers by Application","description":"Lists each developer that can access the given application for this portal.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortApplicationDevelopers"},{"name":"filter","in":"query","description":"Filter application developers returned in the response.","required":false,"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListApplicationDevelopers"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListDevelopersByApplicationBadRequestExample1":{"$ref":"#/components/examples/ListDevelopersByApplicationBadRequestExample1"},"ListDevelopersByApplicationBadRequestExample2":{"$ref":"#/components/examples/ListDevelopersByApplicationBadRequestExample2"},"ListDevelopersByApplicationBadRequestExample3":{"$ref":"#/components/examples/ListDevelopersByApplicationBadRequestExample3"},"ListDevelopersByApplicationBadRequestExample4":{"$ref":"#/components/examples/ListDevelopersByApplicationBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]}},"/applications/{applicationId}":{"parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"get":{"operationId":"get-application-unscoped","summary":"Get an Application","description":"Returns the configuration of a single application in any portal. If an application is linked to a DCR Provider, the `dcr_provider.id` and `client_id` can be used to correlate it. An application manages a set of credentials and registrations for specific APIs.","responses":{"200":{"$ref":"#/components/responses/GetApplication"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]}},"/portals/{portalId}/applications/{applicationId}/credentials":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"get":{"operationId":"list-credentials-by-application","summary":"List Credentials by Application","description":"Lists all credentials for an application. This endpoint returns both API key credentials and DCR credentials, depending on the auth strategy the application uses: - For DCR applications: Credential information is retrieved from the identity provider using provider-specific APIs - For Key-Auth applications: Returns information about credentials Basic information about the credential is returned, but not the credential secret itself.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListApplicationCredentials"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]}},"/portals/{portalId}/application-registrations":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-registrations","summary":"List Registrations by Portal","description":"Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API. Access is provided through the credentials issued to the application that contains each registration.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortListAllApplicationRegistrations"},{"name":"filter","in":"query","description":"Filter application registrations returned in the response.","required":false,"schema":{"type":"object","properties":{"developer_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"application_name":{"$ref":"#/components/schemas/StringFieldFilter"},"status":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListApplicationRegistrations"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListApplicationRegistrationsByPortalBadRequestExample1":{"$ref":"#/components/examples/ListApplicationRegistrationsByPortalBadRequestExample1"},"ListApplicationRegistrationsByPortalBadRequestExample2":{"$ref":"#/components/examples/ListApplicationRegistrationsByPortalBadRequestExample2"},"ListApplicationRegistrationsByPortalBadRequestExample3":{"$ref":"#/components/examples/ListApplicationRegistrationsByPortalBadRequestExample3"},"ListApplicationRegistrationsByPortalBadRequestExample4":{"$ref":"#/components/examples/ListApplicationRegistrationsByPortalBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Application Registrations"]}},"/portals/{portalId}/applications/{applicationId}/registrations":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"get":{"operationId":"list-registrations-by-application","summary":"List Registrations by Application","description":"Lists each API that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortApplicationRegistrations"},{"name":"filter","in":"query","description":"Filter application registrations returned in the response.","required":false,"schema":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListApplicationRegistrations"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListRegistrationsByApplicationBadRequestExample1":{"$ref":"#/components/examples/ListRegistrationsByApplicationBadRequestExample1"},"ListRegistrationsByApplicationBadRequestExample2":{"$ref":"#/components/examples/ListRegistrationsByApplicationBadRequestExample2"},"ListRegistrationsByApplicationBadRequestExample3":{"$ref":"#/components/examples/ListRegistrationsByApplicationBadRequestExample3"},"ListRegistrationsByApplicationBadRequestExample4":{"$ref":"#/components/examples/ListRegistrationsByApplicationBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Application Registrations"]}},"/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/RegistrationId"}],"get":{"operationId":"get-application-registration","summary":"Get a Registration","description":"Returns information about an application's registration status for a particular API.","responses":{"200":{"$ref":"#/components/responses/GetApplicationRegistration"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Application Registrations"]},"patch":{"operationId":"update-application-registration","summary":"Update Registration","description":"Updates the status of a particular application registration to an API. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.","requestBody":{"$ref":"#/components/requestBodies/UpdateApplicationRegistration"},"responses":{"200":{"$ref":"#/components/responses/UpdateApplicationRegistration"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateApplicationRegistrationBadRequestExample1":{"$ref":"#/components/examples/UpdateApplicationRegistrationBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Application Registrations"]},"delete":{"operationId":"delete-application-registration","summary":"Delete Registration","description":"Deletes an application registration, which if currently approved will immediately block API traffic to the API.\nNote: Developers can request a new application registration for the given API as long as they have RBAC access to consume.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Application Registrations"]}},"/portals/{portalId}/authentication-settings":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-authentication-settings","summary":"Get Auth Settings","description":"Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.","responses":{"200":{"$ref":"#/components/responses/PortalAuthenticationSettings"},"401":{"$ref":"#/components/responses/Unauthorized"}},"tags":["Portal Auth Settings"]},"patch":{"operationId":"update-portal-authentication-settings","summary":"Update Auth Settings","description":"Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On through an Identity Provider. Developers can be automatically assigned to teams by mapping claims from their IdP account.","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalAuthenticationSettings"},"responses":{"200":{"$ref":"#/components/responses/PortalAuthenticationSettings"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateAuthSettingsBadRequestExample1":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample1"},"UpdateAuthSettingsBadRequestExample2":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample2"},"UpdateAuthSettingsBadRequestExample3":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample3"},"UpdateAuthSettingsBadRequestExample4":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample4"},"UpdateAuthSettingsBadRequestExample5":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample5"},"UpdateAuthSettingsBadRequestExample6":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample6"},"UpdateAuthSettingsBadRequestExample7":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample7"},"UpdateAuthSettingsBadRequestExample8":{"$ref":"#/components/examples/UpdateAuthSettingsBadRequestExample8"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Auth Settings"]}},"/portals/{portalId}/identity-provider/team-group-mappings":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-team-group-mappings","summary":"List Team Group Mappings","description":"**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nLists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/PortalTeamGroupMappingCollection"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListTeamGroupMappingsBadRequestExample1":{"$ref":"#/components/examples/ListTeamGroupMappingsBadRequestExample1"},"ListTeamGroupMappingsBadRequestExample2":{"$ref":"#/components/examples/ListTeamGroupMappingsBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Auth Settings"]},"patch":{"operationId":"update-portal-team-group-mappings","summary":"Update Team Group Mappings","description":"**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nAllows partial updates to the mappings between Konnect portal teams and Identity Provider (IdP) groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.\nReturns a 400 error if an IdP has not yet been configured, or if a team ID in the request body is not found or is not a UUID.","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalTeamGroupMappings"},"responses":{"200":{"$ref":"#/components/responses/PortalTeamGroupMappingCollection"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateTeamGroupMappingsBadRequestExample1":{"$ref":"#/components/examples/UpdateTeamGroupMappingsBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Auth Settings"]}},"/portals/{portalId}/teams":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-teams","summary":"List Teams","description":"Lists the developer teams in a portal. Each team can contain any developer and developers can be part of multiple teams.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter teams returned in the response.","required":false,"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"can_own_applications":{"$ref":"#/components/schemas/BooleanFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalTeams"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Teams"]},"post":{"operationId":"create-portal-team","summary":"Create Team","description":"Creates a developer team in a portal. Developers can be added to teams to provide RBAC access to API products. Teams can be assigned roles that grant permissions to perform an action on a resource.","requestBody":{"$ref":"#/components/requestBodies/PortalCreateTeam"},"responses":{"201":{"$ref":"#/components/responses/PortalTeam"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"CreateTeamBadRequestExample1":{"$ref":"#/components/examples/CreateTeamBadRequestExample1"},"CreateTeamBadRequestExample2":{"$ref":"#/components/examples/CreateTeamBadRequestExample2"},"CreateTeamBadRequestExample3":{"$ref":"#/components/examples/CreateTeamBadRequestExample3"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Teams"]}},"/portals/{portalId}/teams/{teamId}":{"parameters":[{"$ref":"#/components/parameters/TeamId"},{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-team","summary":"Get Team","description":"Get an individual team.","responses":{"200":{"$ref":"#/components/responses/PortalTeam"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Teams"]},"patch":{"operationId":"update-portal-team","summary":"Update Team","description":"Updates an individual developer team for a portal.","requestBody":{"$ref":"#/components/requestBodies/PortalUpdateTeam"},"responses":{"200":{"$ref":"#/components/responses/PortalTeam"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Teams"]},"delete":{"operationId":"delete-portal-team","summary":"Delete Team","description":"Deletes a developer team from a portal. Deleting a team also deletes its assigned roles. Members of the team are not deleted, but they will lose any access provided through the team.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Teams"]}},"/portals/{portalId}/teams/{teamId}/developers":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/TeamId"}],"get":{"operationId":"list-portal-team-developers","summary":"List Team Developers","description":"List a team's developers.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter developers returned in the response.","required":false,"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/StringFieldFilter"},"full_name":{"$ref":"#/components/schemas/StringFieldFilter"},"attributes":{"$ref":"#/components/schemas/StringFieldFilter"},"active":{"$ref":"#/components/schemas/BooleanFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListBasicDevelopers"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Team Membership"]},"post":{"operationId":"add-developer-to-portal-team","summary":"Add Developer to Team","description":"Adds a developer to a team. This associates them with all of the roles that have been assigned to the team, providing specific permissions to perform actions on resources.","requestBody":{"$ref":"#/components/requestBodies/AddDeveloperToTeam"},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"AddDeveloperToTeamBadRequestExample1":{"$ref":"#/components/examples/AddDeveloperToTeamBadRequestExample1"},"AddDeveloperToTeamBadRequestExample2":{"$ref":"#/components/examples/AddDeveloperToTeamBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portal Team Membership"]}},"/portals/{portalId}/teams/{teamId}/developers/{developerId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/DeveloperId"},{"$ref":"#/components/parameters/TeamId"}],"delete":{"operationId":"remove-developer-from-portal-team","summary":"Remove Developer from Team","description":"Removes a developer from a team. This removes the association of the team's roles from the developer.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Team Membership"]}},"/portals/{portalId}/teams/{teamId}/assigned-roles":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/TeamId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"get":{"operationId":"list-portal-team-roles","summary":"List Team Roles","description":"Lists the roles belonging to a developer team. Each role provides permissions to perform actions on a specified resource or collection.","responses":{"200":{"$ref":"#/components/responses/AssignedPortalRoleCollection"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Team Roles"]},"post":{"operationId":"assign-role-to-portal-teams","summary":"Assign Role","description":"Assign a role to a developer team. This associates the set of permissions in a role with the team, so that they will be applied to any developer who is a member of the team.","requestBody":{"$ref":"#/components/requestBodies/PortalAssignRole"},"responses":{"201":{"$ref":"#/components/responses/PortalAssignedRole"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"AssignRoleBadRequestExample1":{"$ref":"#/components/examples/AssignRoleBadRequestExample1"},"AssignRoleBadRequestExample2":{"$ref":"#/components/examples/AssignRoleBadRequestExample2"},"AssignRoleBadRequestExample3":{"$ref":"#/components/examples/AssignRoleBadRequestExample3"},"AssignRoleBadRequestExample4":{"$ref":"#/components/examples/AssignRoleBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portal Team Roles"]}},"/portals/{portalId}/teams/{teamId}/assigned-roles/{roleId}":{"parameters":[{"$ref":"#/components/parameters/RoleId"},{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/TeamId"}],"delete":{"operationId":"remove-role-from-portal-team","summary":"Remove Role","description":"Removes an assigned role from a developer team. This deletes the association of the role with team and each of its members.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Team Roles"]}},"/portals/{portalId}/developers":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-developers","summary":"List Developers","description":"Lists the developers that have registered for this portal. Each developer can be registered to one portal and must be approved to login unless using the developer auto-approve setting.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortDevelopers"},{"name":"filter","in":"query","description":"Filter developers returned in the response.","required":false,"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"status":{"$ref":"#/components/schemas/StringFieldFilter"},"email":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListDevelopers"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListDevelopersBadRequestExample1":{"$ref":"#/components/examples/ListDevelopersBadRequestExample1"},"ListDevelopersBadRequestExample2":{"$ref":"#/components/examples/ListDevelopersBadRequestExample2"},"ListDevelopersBadRequestExample3":{"$ref":"#/components/examples/ListDevelopersBadRequestExample3"},"ListDevelopersBadRequestExample4":{"$ref":"#/components/examples/ListDevelopersBadRequestExample4"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]}},"/portals/{portalId}/developers/{developerId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/DeveloperId"}],"get":{"operationId":"get-developer","summary":"Get a Developer","description":"Returns information about a single developer in this portal. Each developer manages a set applications, providing them credentials to access registered APIs. Developer registration access can be limited to specific APIs using RBAC.","responses":{"200":{"$ref":"#/components/responses/GetDeveloper"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]},"patch":{"operationId":"update-developer","summary":"Update Developer","description":"Updates the status of a particular developer. Approved developers have access to login to the portal. Revoked, rejected, or pending are not allowed to login. Even if a developer's status is no longer approved, they will still be able to using any existing credentials generated while they were approved, until each application registration is revoked or deleted.","requestBody":{"$ref":"#/components/requestBodies/UpdateDeveloper"},"responses":{"200":{"$ref":"#/components/responses/UpdateDeveloper"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateDeveloperBadRequestExample1":{"$ref":"#/components/examples/UpdateDeveloperBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]},"delete":{"operationId":"delete-developer","summary":"Delete Developer","description":"Deletes a developer, which will discontinue their ability to login, view any non-public resources, and delete all applications owned by them. All credentials issued to the developer will no longer provide access to any APIs. A deleted developer's unique email must be re-registered and approved to gain access again.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]}},"/portals/{portalId}/developers/{developerId}/teams":{"parameters":[{"$ref":"#/components/parameters/DeveloperId"},{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-developer-teams","summary":"List Developer Teams","description":"Lists the teams to which a developer belongs. Each team a developer is a member of grants them various roles that provide permissions to perform actions on certain resources.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter teams returned in the response.","required":false,"schema":{"type":"object","properties":{"can_own_applications":{"$ref":"#/components/schemas/BooleanFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalTeams"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Team Membership"]}},"/portal-roles":{"get":{"operationId":"list-portal-roles","summary":"List Portal Roles","description":"List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.","responses":{"200":{"$ref":"#/components/responses/ListRoles"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Team Roles"]}},"/portals/{portalId}/identity-providers":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-identity-providers","summary":"List Identity Providers","description":"Retrieves the identity providers available within the portal. This operation provides information about\nvarious identity providers for SAML or OIDC authentication integrations.\n","parameters":[{"name":"filter","in":"query","description":"Filter identity providers returned in the response.","required":false,"schema":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/IdentityProviders"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Auth Settings"]},"post":{"operationId":"create-portal-identity-provider","summary":"Create Identity Provider","description":"Creates a new identity provider. This operation allows the creation of a new identity provider for\nauthentication purposes.\n","requestBody":{"$ref":"#/components/requestBodies/CreateIdentityProviderRequest"},"responses":{"201":{"$ref":"#/components/responses/IdentityProvider"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portal Auth Settings"]}},"/portals/{portalId}/identity-providers/{id}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/IdentityProviderId"}],"get":{"operationId":"get-portal-identity-provider","summary":"Get Identity Provider","description":"Retrieves the configuration of a single identity provider. This operation returns information about a\nspecific identity provider's settings and authentication integration details.\n","responses":{"200":{"$ref":"#/components/responses/IdentityProvider"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Auth Settings"]},"patch":{"operationId":"update-portal-identity-provider","summary":"Update Identity Provider","description":"Updates the configuration of an existing identity provider. This operation allows modifications to be made\nto an existing identity provider's configuration.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateIdentityProviderRequest"},"responses":{"200":{"$ref":"#/components/responses/IdentityProvider"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portal Auth Settings"]},"delete":{"operationId":"delete-portal-identity-provider","summary":"Delete Identity Provider","description":"Deletes an existing identity provider configuration. This operation removes a specific identity provider\nfrom the portal.\n","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Auth Settings"]}},"/portals/{portalId}/audit-log-replay-job":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"put":{"operationId":"update-portal-audit-log-replay-job","summary":"Update Portal Audit Log Replay Job","description":"Updates a job to re-send audit logs to an portal's webhook.","requestBody":{"$ref":"#/components/requestBodies/ReplacePortalAuditLogReplayJob"},"responses":{"202":{"$ref":"#/components/responses/PortalAuditLogReplayJob"},"400":{"$ref":"#/components/responses/PortalReplayJobBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/PortalReplayJobConflict"}},"tags":["Portal Audit Logs"]},"get":{"operationId":"get-portal-audit-log-replay-job","summary":"Get Portal Audit Log Replay Job","description":"Returns the audit log replay job's configuration and status.","responses":{"200":{"$ref":"#/components/responses/PortalAuditLogReplayJob"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Audit Logs"]}},"/portals/{portalId}/audit-log-webhook":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"patch":{"operationId":"update-portal-audit-log-webhook","summary":"Update Portal Audit Log Webhook","description":"Updates the configuration for a webhook to receive audit logs.","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalAuditLogWebhook"},"responses":{"200":{"$ref":"#/components/responses/PortalAuditLogWebhook"},"400":{"$ref":"#/components/responses/PortalWebhookBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Audit Logs"]},"get":{"operationId":"get-portal-audit-log-webhook","summary":"Get Portal Audit Log Webhook","description":"Returns configuration for the audit log webhook.","responses":{"200":{"$ref":"#/components/responses/PortalAuditLogWebhook"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Audit Logs"]},"delete":{"operationId":"delete-portal-audit-log-webhook","summary":"Delete Portal Audit Log Webhook","description":"Removes configuration for the audit log webhook. The destination ID is set to empty, and the webhook enabled field is set to false","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Portal Audit Logs"]}},"/portals/{portalId}/audit-log-webhook/status":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-audit-log-webhook-status","summary":"Get Portal Audit Log Webhook Status","description":"Returns status of the audit log webhook.","responses":{"200":{"$ref":"#/components/responses/PortalAuditLogWebhookStatus"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Audit Logs"]}},"/portals/email-domains":{"get":{"operationId":"list-email-domains","summary":"List email domains","description":"List email domains","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortEmailDomains"},{"name":"filter","in":"query","description":"Filter email domains returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/EmailDomainFilterParameters"},"style":"deepObject"}],"responses":{"200":{"description":"List of a email domains","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDomains"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Emails"]},"post":{"operationId":"create-email-domain","summary":"Create an email domain","description":"Create an email domain","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDomainPayload"}}}},"responses":{"201":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDomain"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/email-domains/{emailDomain}":{"parameters":[{"$ref":"#/components/parameters/EmailDomain"}],"get":{"operationId":"get-email-domain","summary":"Get an email domain","description":"Get an email domain","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDomain"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]},"delete":{"operationId":"delete-email-domain","summary":"Delete an email domain","description":"Delete an email domain","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/{portalId}/email-delivery":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-email-delivery","summary":"Get the email delivery for the portal","description":"Retrieve the email delivery for the portal","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"tags":["Portal Emails"]},"patch":{"operationId":"update-email-delivery","summary":"Setup the email delivery for a portal","description":"Setup the email delivery for a portal","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDeliveryUpdatePayload"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDelivery"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"tags":["Portal Emails"]},"delete":{"operationId":"delete-email-delivery","summary":"Delete email delivery","description":"Delete email delivery","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"tags":["Portal Emails"]}},"/portals/{portalId}/email-config":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-email-config","summary":"Get the email config for the portal","description":"Retrieve the email config for the portal","responses":{"200":{"$ref":"#/components/responses/PortalEmailConfigResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]},"post":{"operationId":"create-portal-email-config","summary":"Create the email config for a portal","description":"Create the email config for a portal","requestBody":{"$ref":"#/components/requestBodies/PostPortalEmailConfigPayload"},"responses":{"201":{"$ref":"#/components/responses/PortalEmailConfigResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"tags":["Portal Emails"]},"patch":{"operationId":"update-portal-email-config","summary":"Setup the email config for a portal","description":"Setup the email config for a portal","requestBody":{"$ref":"#/components/requestBodies/PatchPortalEmailConfigPayload"},"responses":{"200":{"$ref":"#/components/responses/PortalEmailConfigResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]},"delete":{"operationId":"delete-portal-email-config","summary":"Delete portal email config","description":"Delete portal email config","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/email-templates":{"get":{"operationId":"list-default-email-templates","summary":"List default email templates","description":"List default email templates","responses":{"200":{"$ref":"#/components/responses/ListDefaultEmailTemplates"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/email-templates/variables":{"get":{"operationId":"list-email-template-variables","summary":"List email template variables","description":"List email template variables","responses":{"200":{"$ref":"#/components/responses/EmailTemplateVariables"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/email-templates/{templateName}":{"parameters":[{"$ref":"#/components/parameters/EmailTemplateName"}],"get":{"operationId":"get-default-email-template","summary":"Get default email template","description":"Get default email template","responses":{"200":{"$ref":"#/components/responses/DefaultEmailTemplate"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/{portalId}/email-templates":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-custom-email-templates","summary":"List custom email templates for a portal","description":"List custom email templates","responses":{"200":{"$ref":"#/components/responses/ListEmailTemplates"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/{portalId}/email-templates/{templateName}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/EmailTemplateName"}],"get":{"operationId":"get-portal-custom-email-template","summary":"Get custom email template used in a portal","description":"Get custom email template","responses":{"200":{"$ref":"#/components/responses/EmailTemplate"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]},"patch":{"operationId":"update-portal-custom-email-template","summary":"Update custom email template for a portal","description":"Update custom email template","requestBody":{"$ref":"#/components/requestBodies/PatchCustomPortalEmailTemplatePayload"},"responses":{"200":{"$ref":"#/components/responses/PatchEmailTemplateResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]},"delete":{"operationId":"delete-portal-custom-email-template","summary":"Delete custom email template","description":"Delete custom email template for a portal. This will revert to using the default template","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/{portalId}/email-templates/{templateName}/send-test-email":{"post":{"operationId":"post-portal-custom-email-test-send","summary":"Send Test Email","description":"Send a test email based on the portal's email template, using the content provided in the request.\nThe email will be sent to the Konnect user who triggered the test.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/EmailTemplateName"}],"requestBody":{"$ref":"#/components/requestBodies/PostSendTestEmailPayload"},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Emails"]}},"/portals/{portalId}/ip-allow-list":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"post":{"operationId":"create-portal-ip-allow-list","summary":"Create an IP allow list for a portal","description":"Create an IP allow list for a portal.\n","requestBody":{"$ref":"#/components/requestBodies/CreatePortalSourceIPRestriction"},"responses":{"201":{"$ref":"#/components/responses/PortalSourceIPRestriction"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portals IP Allow List"]},"get":{"operationId":"list-portal-ip-allow-list","summary":"List the IP allow list for portal","description":"Lists the IP allow list configuration for a portal.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageBefore"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/PortalSourceIPRestrictionPaginatedResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals IP Allow List"]}},"/portals/{portalId}/ip-allow-list/{id}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"name":"id","in":"path","description":"ID of the allow list.","required":true,"schema":{"type":"string","format":"uuid"}}],"put":{"operationId":"put-portal-ip-allow-list","summary":"Replace an IP allow list for a portal","description":"Replace an IP allow list for a portal.\n","requestBody":{"$ref":"#/components/requestBodies/CreatePortalSourceIPRestriction"},"responses":{"201":{"$ref":"#/components/responses/PortalSourceIPRestriction"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals IP Allow List"]},"patch":{"operationId":"update-portal-ip-allow-list","summary":"Update an IP allow list for a portal","description":"Update an IP allow list for a portal.\n","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalSourceIPRestriction"},"responses":{"201":{"$ref":"#/components/responses/PortalSourceIPRestriction"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals IP Allow List"]},"delete":{"operationId":"delete-portal-ip-allow-list","summary":"Delete an IP allow list from a portal","description":"Delete the IP allow list for a portal.\n","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals IP Allow List"]}}},"components":{"parameters":{"ApplicationId":{"name":"applicationId","in":"path","required":true,"description":"ID of the application.","schema":{"type":"string","format":"uuid"}},"DeveloperId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"developerId","in":"path","required":true,"description":"ID of the developer."},"EmailDomain":{"name":"emailDomain","in":"path","required":true,"description":"Email domain for custom portal email sender","schema":{"type":"string"}},"EmailTemplateName":{"name":"templateName","description":"Name of the email template.","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EmailTemplateName"}},"IdentityProviderId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"id","in":"path","required":true,"description":"ID of the identity provider."},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageBefore":{"name":"page[before]","description":"Request the next page of data, starting with the item before this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageId":{"schema":{"type":"string","format":"uuid","example":"ebbac5b0-ac89-45c3-9d2e-c4542c657e79"},"name":"pageId","in":"path","required":true,"description":"ID of the page."},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"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}},"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."},"RegistrationId":{"name":"registrationId","in":"path","required":true,"description":"ID of the application registration.","schema":{"type":"string","format":"uuid"}},"RoleId":{"schema":{"type":"string","format":"uuid","example":"8350205f-a305-4e39-abe9-bc082a80091a"},"name":"roleId","in":"path","required":true},"SnippetId":{"schema":{"type":"string","format":"uuid","example":"ebbac5b0-ac89-45c3-9d2e-c4542c657e79"},"name":"snippetId","in":"path","required":true,"description":"ID of the snippet."},"SortApplicationDevelopers":{"name":"sort","description":"Sorts a set of developers for an application. Supported sort attributes are:\n  - id\n","in":"query","required":false,"schema":{"type":"string"}},"SortApplicationRegistrations":{"name":"sort","description":"Sorts a set of registrations for an application. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - status\n","in":"query","required":false,"schema":{"type":"string"}},"SortApplications":{"name":"sort","description":"Sorts a collection of applications. Supported sort attributes are:\n  - created_at\n  - developer_id\n  - name\n","in":"query","required":false,"schema":{"type":"string"}},"SortDevelopers":{"name":"sort","description":"Sorts a collection of developers. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - email\n  - name\n  - status\n","in":"query","required":false,"schema":{"type":"string"}},"SortEmailDomains":{"name":"sort","description":"Sorts a collection of email domains. Supported sort attributes are:\n  - domain\n  - created_at\n  - updated_at\n","in":"query","required":false,"schema":{"type":"string"}},"SortListAllApplicationRegistrations":{"name":"sort","description":"Sorts a collection of application registrations. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - developer_id\n  - status\n","in":"query","required":false,"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"}},"SortPortals":{"name":"sort","description":"Sorts a collection of portals. Supported sort attributes are:\n  - name\n  - description\n  - authentication_enabled\n  - rbac_enabled\n  - auto_approve_applications\n  - auto_approve_developers\n  - default_domain\n  - canonical_domain\n  - created_at\n  - updated_at\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"}},"TeamId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"teamId","in":"path","required":true,"description":"ID of the team."}},"schemas":{"PortalImageDataUri":{"oneOf":[{"$ref":"#/components/schemas/ImagePNGDataUri"},{"$ref":"#/components/schemas/ImageJPGDataUri"},{"$ref":"#/components/schemas/ImageGIFDataUri"},{"$ref":"#/components/schemas/ImageICODataUri"},{"$ref":"#/components/schemas/ImageSVGDataUri"}],"title":"PortalImageDataUri"},"PortalImageAssetBlob":{"description":"Raw binary image data","type":"string","format":"binary","title":"PortalImageAsset"},"ReplacePortalImageAsset":{"description":"The image data to upload. Images must be a data URL with binary image data in base 64 format. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.","type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalImageDataUri"}},"example":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"additionalProperties":false,"nullable":true,"required":["data"],"title":"ReplacePortalImageAsset"},"UpdateDeveloperRequest":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/DeveloperStatus"}},"example":{"status":"approved"},"additionalProperties":false,"title":"UpdateDeveloperRequest"},"PortalDeveloper":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"email":{"type":"string","format":"email","maxLength":255},"full_name":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/DeveloperStatus"}},"example":{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},"additionalProperties":false,"required":["id","created_at","updated_at","email","full_name","status"],"title":"PortalDeveloper"},"BasicDeveloper":{"description":"Basic information about a developer.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"email":{"type":"string","format":"email","example":"developer@email.com","maxLength":250},"full_name":{"type":"string","example":"API Developer","maxLength":250,"pattern":"^[\\w \\W]+$"},"active":{"type":"boolean","example":true,"readOnly":true},"created_at":{"type":"string","format":"date-time","example":"2022-02-07T17:46:57.52Z","readOnly":true},"updated_at":{"type":"string","format":"date-time","example":"2022-10-08T17:00:00.52Z","readOnly":true}},"example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"API Developer","active":true,"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"},"title":"BasicDeveloper"},"ListDevelopersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalDeveloper"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":4}},"data":[{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jane.developer@example.com","full_name":"Jane Dev","status":"approved","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"4cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"John Dev","status":"revoked","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"Jim Dev","status":"pending","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"Jan Dev","status":"rejected","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}]},"additionalProperties":false,"required":["data","meta"]},"DeveloperStatus":{"description":"The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.","type":"string","example":"approved","enum":["approved","pending","revoked","rejected"],"title":"DeveloperStatus"},"MovePageRequestPayload":{"description":"move page request payload","type":"object","properties":{"parent_page_id":{"description":"parent page id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"},"index":{"description":"index of the document in the parent document's children","type":"integer","example":1}},"title":"MovePage"},"PageSlug":{"description":"The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.\nWhen a page has a `parent_page_id`, its full path is built by joining the parent’s slug with its own.\nFor example, if a parent page has the slug `slug1` and this page’s slug is `slug2`, the resulting path will be `/slug1/slug2`.\nThis enables nested page structures like `/slug1/slug2/slug3`.\n","type":"string","example":"/my-page","maxLength":512,"title":"PageSlug"},"ParentPageId":{"description":"Pages may be rendered as a tree of files.\n\nSpecify the `id` of another page as the `parent_page_id` to add some hierarchy to your pages.\n","type":"string","format":"uuid","example":null,"nullable":true},"PageTitle":{"description":"The title of a page in a portal.","type":"string","example":"My Page","maxLength":512,"title":"PageTitle"},"PageContent":{"description":"The renderable markdown content of a page in a portal.","type":"string","example":"# Welcome to My Page","maxLength":1000000,"title":"PageContent"},"SnippetName":{"description":"The unique name of a snippet in a portal.","type":"string","example":"my-snippet","maxLength":512,"title":"SnippetName"},"SnippetTitle":{"description":"The display title of a snippet in a portal.","type":"string","example":"My Snippet","maxLength":512,"title":"SnippetTitle"},"SnippetContent":{"description":"The renderable markdown content of a page in a portal.","type":"string","example":"# Welcome to My Snippet","maxLength":1000000,"title":"SnippetContent"},"VisibilityStatus":{"description":"Whether the resource is publicly accessible to non-authenticated users.","type":"string","example":"public","enum":["public","private"],"title":"VisibilityStatus"},"PublishedStatus":{"description":"Whether the resource is visible on a given portal. Defaults to unpublished.","type":"string","example":"published","enum":["published","unpublished"],"title":"PublishedStatus"},"Description":{"type":"string","example":"A custom page about developer portals","maxLength":160,"title":"ResourceDescription"},"PageVisibilityStatus":{"description":"Whether a page is publicly accessible to non-authenticated users.\nIf not provided, the default_page_visibility value of the portal will be used.\n","type":"string","example":"public","enum":["public","private"],"title":"PageVisibilityStatus"},"SnippetVisibilityStatus":{"description":"Whether a snippet is publicly accessible to non-authenticated users.\nIf not provided, the default_page_visibility value of the portal will be used.\n","type":"string","example":"public","enum":["public","private"],"title":"PageVisibilityStatus"},"UpdatePortalPageRequest":{"description":"Update a page in a portal.","type":"object","properties":{"slug":{"$ref":"#/components/schemas/PageSlug"},"title":{"$ref":"#/components/schemas/PageTitle"},"content":{"$ref":"#/components/schemas/PageContent"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"},"parent_page_id":{"$ref":"#/components/schemas/ParentPageId"}},"additionalProperties":false,"title":"UpdatePortalPageRequest"},"CreatePortalPageRequest":{"description":"Create a page in a portal.","type":"object","properties":{"slug":{"$ref":"#/components/schemas/PageSlug"},"title":{"$ref":"#/components/schemas/PageTitle"},"content":{"$ref":"#/components/schemas/PageContent"},"visibility":{"$ref":"#/components/schemas/PageVisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"},"parent_page_id":{"$ref":"#/components/schemas/ParentPageId"}},"additionalProperties":false,"required":["slug","content"],"title":"CreatePortalPageRequest"},"PortalPageInfo":{"description":"Information about a page in a portal.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"slug":{"$ref":"#/components/schemas/PageSlug"},"title":{"$ref":"#/components/schemas/PageTitle"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"},"parent_page_id":{"$ref":"#/components/schemas/ParentPageId"},"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","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","status":"unpublished","parent_page_id":null,"children":[]}]},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","slug","title","visibility","created_at","updated_at","status","parent_page_id","children"],"title":"PortalPageInfo"},"PortalSnippetInfo":{"description":"Information about a snippet in a portal.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/SnippetName"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","title","visibility","status","created_at","updated_at"],"title":"PortalSnippetInfo"},"DefaultContent":{"description":"Summary of created default content","type":"object","properties":{"pages":{"type":"array","items":{"type":"string"}},"snippets":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["pages","snippets"],"title":"DefaultContent"},"PortalPageResponse":{"description":"Details about a page in a portal.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"slug":{"$ref":"#/components/schemas/PageSlug"},"title":{"$ref":"#/components/schemas/PageTitle"},"content":{"$ref":"#/components/schemas/PageContent"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"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","slug","title","content","visibility","status","created_at","updated_at","parent_page_id"],"title":"PortalPageResponse"},"ListPortalPagesResponse":{"description":"Tree of custom pages in a portal. Not paginated.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalPageInfo"}}},"example":{"data":[{"id":"437c7192-fea0-4f35-8478-c8d57783f8c1","slug":"/my-page","title":"My Page","visibility":"public","status":"unpublished","description":"A custom page","created_at":"2021-01-01T00:00:00Z","updated_at":"2021-01-01T00:00:00Z","parent_page_id":null,"children":[]}]},"additionalProperties":false,"required":["data"],"title":"ListPortalPagesResponse"},"PortalSnippetResponse":{"description":"Details about a snippet in a portal.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/SnippetName"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"content":{"$ref":"#/components/schemas/SnippetContent"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","content","visibility","status","created_at","updated_at"],"title":"PortalSnippetResponse"},"ListPortalSnippetsResponse":{"description":"A paginated list of custom snippets in a portal.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalSnippetInfo"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"example":{"data":[{"id":"437c7192-fea0-4f35-8478-c8d57783f8c1","name":"my-snippet","title":"My Snippet","visibility":"public","status":"published","description":"A custom snippet","created_at":"2021-01-01T00:00:00Z","updated_at":"2021-01-01T00:00:00Z"}],"meta":{"page":{"number":1,"size":10,"total":1}}},"additionalProperties":false,"required":["data","meta"],"title":"ListPortalSnippetsResponse"},"UpdatePortalSnippetRequest":{"description":"Update a snippet in a portal.","type":"object","properties":{"name":{"$ref":"#/components/schemas/SnippetName"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"content":{"$ref":"#/components/schemas/SnippetContent"},"visibility":{"$ref":"#/components/schemas/VisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"}},"additionalProperties":false,"title":"UpdatePortalSnippetRequest"},"CreatePortalSnippetRequest":{"description":"Create a snippet in a portal.","type":"object","properties":{"name":{"$ref":"#/components/schemas/SnippetName"},"title":{"$ref":"#/components/schemas/SnippetTitle"},"content":{"$ref":"#/components/schemas/SnippetContent"},"visibility":{"$ref":"#/components/schemas/SnippetVisibilityStatus"},"status":{"$ref":"#/components/schemas/PublishedStatus"},"description":{"$ref":"#/components/schemas/Description"}},"additionalProperties":false,"required":["name","content"],"title":"CreatePortalSnippetRequest"},"UpdateApplicationRequest":{"type":"object","properties":{"owner":{"$ref":"#/components/schemas/ApplicationOwner"}},"additionalProperties":false,"title":"UpdateApplicationRequest"},"ListApplicationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":2,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"85606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"},{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"A Konnect application that is linked to an Identity Provider application using Dynamic Client Registration (DCR)","client_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":3,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"65606071-49c7-4c2e-ae49-8a86d72a8110","name":"Client Credentials","credential_type":"client_credentials","auth_methods":["client_credentials","bearer","session"]},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":null,"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z"}]},"additionalProperties":false,"required":["data","meta"]},"GetApplicationResponse":{"$ref":"#/components/schemas/Application"},"ListApplicationDevelopersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationDeveloperDetailed"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":4}},"data":[{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jane.developer@example.com","full_name":"Jane Dev"},{"id":"4cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"John Dev"},{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jim.developer@example.com","full_name":"Jim Dev"},{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jan.developer@example.com","full_name":"Jan Dev"}]},"additionalProperties":false,"required":["data","meta"],"title":"ListApplicationDevelopersResponse"},"ListApplicationRegistrationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRegistration"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"c200cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d200cc33-2d33-4754-b086-a98e0fcd36fb","status":"rejected","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 2"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v2","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d300cc33-2d33-4754-b086-a98e0fcd36fb","status":"pending","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 3"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Stuff","version":"v2","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d300cc33-2d33-4754-b086-a98e0fcd36fb","status":"revoked","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 3"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}]},"additionalProperties":false,"required":["data","meta"],"title":"ListApplicationRegistrationsResponse"},"GetApplicationRegistrationResponse":{"$ref":"#/components/schemas/ApplicationRegistration"},"UpdateApplicationRegistrationResponse":{"$ref":"#/components/schemas/ApplicationRegistration"},"ApplicationDeveloperDetailed":{"description":"List of developers that have a registered application.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"email":{"type":"string","format":"email","example":"developer@email.com","maxLength":250},"full_name":{"type":"string","example":"API Developer","maxLength":250,"pattern":"^[\\w \\W]+$"}},"example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"API Developer"},"additionalProperties":false,"required":["id"],"title":"ApplicationDeveloperDetailed"},"Application":{"example":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}},"oneOf":[{"$ref":"#/components/schemas/ClientCredentialsApplication"},{"$ref":"#/components/schemas/KeyAuthApplication"}],"title":"Application"},"ClientCredentialsApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the application.","type":"string"},"description":{"description":"A description of the application.","type":"string","nullable":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"client_id":{"description":"The ID used to linked the portal application to an Identity Provider application.","type":"string","readOnly":true},"registration_count":{"description":"The number of API registrations that are associated with the application. Registrations of any status are included in the count.","type":"number","readOnly":true},"dcr_provider":{"description":"Information about the DCR provider this application uses, if using DCR.","type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/UUID"}},"required":["id"]},"portal":{"description":"Information about the portal the application is in.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"}},"required":["id"]},"auth_strategy":{"$ref":"#/components/schemas/AuthStrategyClientCredentials"},"granted_scopes":{"description":"List of granted scopes for the application. Null if application type does not support returning granted scopes.","type":"array","items":{"type":"string"},"nullable":true},"owner":{"$ref":"#/components/schemas/ApplicationOwner"}},"additionalProperties":false,"required":["id","created_at","updated_at","name","description","registration_count","client_id","auth_strategy","dcr_provider","portal","labels","granted_scopes"],"title":"Client Credentials Application"},"KeyAuthApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the application.","type":"string"},"description":{"description":"A description of the application.","type":"string","nullable":true},"auth_strategy":{"$ref":"#/components/schemas/AuthStrategyKeyAuth"},"portal":{"description":"Information about the portal the application is in.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"}},"required":["id"]},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"registration_count":{"description":"The number of API registrations that are associated with the application. Registrations of any status are included in the count.","type":"number","readOnly":true},"owner":{"$ref":"#/components/schemas/ApplicationOwner"}},"example":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}},"additionalProperties":false,"required":["id","created_at","updated_at","name","description","auth_strategy","portal","registration_count","labels"],"title":"Key Auth Application"},"ApplicationRegistration":{"description":"A application's registration for a specific version of an API.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"status":{"$ref":"#/components/schemas/ApplicationRegistrationStatus"},"api":{"description":"Details about the API the application is registered to.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the API the application is registered to.","type":"string"},"version":{"description":"The version of the API the application is registered to.","type":"string","nullable":true},"entity_type":{"$ref":"#/components/schemas/EntityType"}},"required":["id","name","version","entity_type"]},"application":{"description":"Details about the application the registration is part of.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the application the registration is part of.","type":"string"}},"required":["id","name"]}},"example":{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},"additionalProperties":false,"required":["id","created_at","updated_at","status","api","application"],"title":"ApplicationRegistration"},"ApplicationRegistrationStatus":{"description":"The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.\nPending, revoked, and rejected registrations will not provide access to the API.","type":"string","example":"approved","enum":["approved","pending","revoked","rejected"],"title":"ApplicationRegistrationStatus"},"UpdateApplicationRegistrationRequest":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ApplicationRegistrationStatus"}},"example":{"status":"rejected"},"additionalProperties":false,"title":"UpdateApplicationRegistrationRequest"},"PortalFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"description":{"$ref":"#/components/schemas/StringFieldFilter"},"authentication_enabled":{"$ref":"#/components/schemas/BooleanFieldFilter"},"rbac_enabled":{"$ref":"#/components/schemas/BooleanFieldFilter"},"default_api_visibility":{"$ref":"#/components/schemas/StringFieldFilter"},"default_page_visibility":{"$ref":"#/components/schemas/StringFieldFilter"},"default_application_auth_strategy_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"auto_approve_developers":{"$ref":"#/components/schemas/BooleanFieldFilter"},"auto_approve_applications":{"$ref":"#/components/schemas/BooleanFieldFilter"},"default_domain":{"$ref":"#/components/schemas/StringFieldFilter"},"canonical_domain":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"PortalFilterParameters"},"PortalPagesFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"slug":{"$ref":"#/components/schemas/StringFieldFilter"},"title":{"$ref":"#/components/schemas/StringFieldFilter"},"visibility":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"PortalPagesFilterParameters"},"PortalSnippetsFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"title":{"$ref":"#/components/schemas/StringFieldFilter"},"visibility":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"PortalSnippetsFilterParameters"},"PortalCustomDomain":{"type":"object","properties":{"hostname":{"type":"string"},"enabled":{"type":"boolean"},"ssl":{"$ref":"#/components/schemas/PortalCustomDomainSSL"},"cname_status":{"$ref":"#/components/schemas/PortalCustomDomainCnameStatus"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["hostname","enabled","ssl","cname_status","created_at","updated_at"],"title":"PortalCustomDomain"},"PortalCustomDomainSSL":{"type":"object","properties":{"domain_verification_method":{"$ref":"#/components/schemas/PortalCustomDomainVerificationMethod"},"verification_status":{"$ref":"#/components/schemas/PortalCustomDomainVerificationStatus"},"validation_errors":{"$ref":"#/components/schemas/PortalCustomDomainValidationErrors"},"uploaded_at":{"description":"An ISO-8601 timestamp representation of the ssl certificate upload date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"expires_at":{"description":"An ISO-8601 timestamp representation of the ssl certificate expiration date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"skip_ca_check":{"description":"True when the provided certificate chain is served as-is without validation against a public trust store.\n","type":"boolean","readOnly":true}},"additionalProperties":false,"required":["domain_verification_method","verification_status"],"title":"PortalCustomDomainSSL"},"CreatePortalCustomDomainSSL":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CreatePortalCustomDomainSSLWithCustomCertificate"},{"$ref":"#/components/schemas/CreatePortalCustomDomainSSLStandard"}],"title":"CreatePortalCustomDomainSSL"},"CreatePortalCustomDomainSSLWithCustomCertificate":{"properties":{"domain_verification_method":{"type":"string","enum":["custom_certificate"],"x-terraform-transform-const":true},"custom_certificate":{"description":"Custom certificate to be used for the SSL termination.","type":"string"},"custom_private_key":{"description":"Custom certificate private key to be used for the SSL termination.","type":"string"},"skip_ca_check":{"description":"Advanced option. If true, the custom certificate is served exactly as provided, without attempting to bundle against a public trust store. Required for certificates issued by an internal/private CA.\n","type":"boolean","default":false}},"additionalProperties":false,"required":["domain_verification_method","custom_certificate","custom_private_key"],"title":"custom_certificate"},"CreatePortalCustomDomainSSLStandard":{"properties":{"domain_verification_method":{"type":"string","enum":["http"],"x-terraform-transform-const":true}},"additionalProperties":false,"required":["domain_verification_method"],"title":"http"},"PortalCustomDomainVerificationMethod":{"type":"string","enum":["http","custom_certificate"],"title":"PortalCustomDomainVerificationMethod"},"PortalCustomDomainVerificationStatus":{"type":"string","enum":["verified","pending","error"],"readOnly":true,"title":"PortalCustomDomainVerificationStatus"},"PortalCustomDomainCnameStatus":{"type":"string","enum":["verified","pending"],"readOnly":true,"title":"PortalCustomDomainCnameStatus"},"PortalCustomDomainValidationErrors":{"type":"array","items":{"type":"string"},"readOnly":true,"title":"PortalCustomDomainValidationErrors"},"CreatePortalCustomDomainRequest":{"type":"object","properties":{"hostname":{"type":"string"},"enabled":{"type":"boolean"},"ssl":{"$ref":"#/components/schemas/CreatePortalCustomDomainSSL"}},"additionalProperties":false,"required":["hostname","enabled","ssl"],"title":"CreatePortalCustomDomainRequest"},"UpdatePortalCustomDomainRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}},"additionalProperties":false,"title":"UpdatePortalCustomDomainRequest"},"PortalClaimMappings":{"description":"Mappings from a portal developer atribute to an Identity Provider claim.","type":"object","properties":{"name":{"type":"string","example":"name","default":"name"},"email":{"type":"string","example":"email","default":"email"},"groups":{"type":"string","example":"custom-group-claim","default":"groups"}},"example":{"name":"name","email":"email","groups":"custom-group-claim"},"maxProperties":3,"minProperties":0,"title":"PortalClaimMappings"},"OIDCAuthEnabled":{"description":"The portal has OIDC enabled or disabled.","type":"boolean","example":false,"deprecated":true},"SAMLAuthEnabled":{"description":"A Konnect Identity Admin assigns teams to a developer.","type":"boolean","example":false,"deprecated":true},"OIDCIdpMappingEnabled":{"description":"IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.","type":"boolean","example":true,"deprecated":true},"IDPMappingEnabled":{"description":"Whether IdP groups determine the Konnect Portal teams a developer has.","type":"boolean","example":true},"PortalAuthenticationSettingsResponse":{"description":"The developer authentication settings for a portal.","type":"object","properties":{"basic_auth_enabled":{"description":"The portal has basic auth enabled or disabled.","type":"boolean","example":true},"oidc_auth_enabled":{"$ref":"#/components/schemas/OIDCAuthEnabled"},"saml_auth_enabled":{"$ref":"#/components/schemas/SAMLAuthEnabled"},"oidc_team_mapping_enabled":{"$ref":"#/components/schemas/OIDCIdpMappingEnabled"},"idp_mapping_enabled":{"$ref":"#/components/schemas/IDPMappingEnabled"},"konnect_mapping_enabled":{"description":"A Konnect Identity Admin assigns teams to a developer.","type":"boolean","example":false},"oidc_config":{"description":"Configuration properties for an OpenID Connect Identity Provider.","type":"object","example":{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}},"deprecated":true,"properties":{"issuer":{"type":"string","example":"https://identity.example.com/v2"},"client_id":{"type":"string","example":"x7id0o42lklas0blidl2"},"scopes":{"type":"array","items":{"type":"string","default":"openid"},"example":["email","openid","profile"],"default":["email","openid","profile"]},"claim_mappings":{"$ref":"#/components/schemas/PortalClaimMappings"}},"readOnly":true,"required":["issuer","client_id"],"title":"PortalOIDCConfig"}},"example":{"basic_auth_enabled":true,"oidc_auth_enabled":true,"oidc_team_mapping_enabled":true,"konnect_mapping_enabled":false,"oidc_config":{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}},"required":["basic_auth_enabled","konnect_mapping_enabled","oidc_auth_enabled","oidc_team_mapping_enabled"],"title":"PortalAuthenticationSettingsResponse"},"AssignedPortalRoleCollectionResponse":{"description":"A paginated list of roles assigned to a team.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalAssignedRoleResponse"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":3}},"data":[{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adce","role_name":"API Viewer","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Services","entity_region":"us"},{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adce","role_name":"API Consumer","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Services","entity_region":"us"},{"id":"869d9402-f117-4f9a-840f-69acaf70a81a","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}]},"required":["meta","data"],"title":"AssignedPortalRoleCollectionResponse"},"ListPortalTeamsResponse":{"description":"A paginated list of teams in a portal.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalTeamResponse"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":3}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Partner","description":"Team with access to Partner APIs","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":false},{"id":"af9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Internal","description":"Team with access to Internal APIs","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":true},{"id":"4f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Root","description":"Team with access to Internal Systems","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":true}]},"required":["data","meta"],"title":"ListPortalTeamsResponse"},"ListRolesResponse":{"description":"The set of roles available to associate with resources and assign to teams.","type":"object","properties":{"services":{"type":"object","properties":{"name":{"type":"string","enum":["Services"]},"roles":{"type":"object","properties":{"apiviewer":{"type":"object","properties":{"name":{"type":"string","enum":["API Viewer"]},"description":{"type":"string","enum":["API Viewers have read-only access to the documentation of a service in a portal"]}},"required":["name","description"]},"apiconsumer":{"type":"object","properties":{"name":{"type":"string","enum":["API Consumer"]},"description":{"type":"string","enum":["API Consumers can make calls to the given service"]}},"required":["name","description"]}},"required":["apiviewer","apiconsumer"]}},"required":["name","roles"]}},"example":{"services":{"name":"Services","roles":{"apiviewer":{"name":"API Viewer","description":"API Viewers have read-only access to the documentation of a service in a portal"},"apiconsumer":{"name":"API Consumer","description":"API Consumers can make calls to the given service"}}}},"required":["services"],"title":"ListRolesResponse"},"ListBasicDevelopersResponse":{"description":"A paginated list of basic information about a set of developers.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BasicDeveloper"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"james.woods@email.com","full_name":"James Woods","active":true,"created_at":"2022-08-17T17:46:57.52Z","updated_at":"2022-10-03T17:00:00.00Z"},{"id":"4f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"jill.stone@email.com","full_name":"Jill Stone","active":false,"created_at":"2022-07-17T17:46:57.52Z","updated_at":"2022-10-03T17:00:00.00Z"}]},"title":"ListBasicDevelopersResponse"},"AddDeveloperToTeamRequest":{"description":"Add a developer to a team by specifying the developer ID.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b","writeOnly":true}},"example":{"id":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"},"required":["id"],"title":"AddDeveloperToTeamRequest"},"PortalAssignRoleRequest":{"description":"An assigned role associates a service and an action to a team.","type":"object","properties":{"role_name":{"type":"string","example":"API Viewer"},"entity_id":{"type":"string","format":"uuid","example":"e67490ce-44dc-4cbd-b65e-b52c746fc26a"},"entity_type_name":{"type":"string","example":"Services"},"entity_region":{"description":"Region of the entity.","type":"string","example":"eu","enum":["us","eu","au","me","in","sg","*"]}},"example":{"role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"},"required":["role_name","entity_id","entity_type_name","entity_region"],"title":"PortalAssignRoleRequest"},"PortalAuthenticationSettingsUpdateRequest":{"description":"Properties to update a portal's developer auth settings.","type":"object","properties":{"basic_auth_enabled":{"description":"The organization has basic auth enabled.","type":"boolean","example":true},"oidc_auth_enabled":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"boolean","example":false,"deprecated":true},"saml_auth_enabled":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"boolean","example":false,"deprecated":true},"oidc_team_mapping_enabled":{"$ref":"#/components/schemas/OIDCIdpMappingEnabled"},"konnect_mapping_enabled":{"description":"Whether a Konnect Identity Admin assigns teams to a developer.","type":"boolean","example":false},"idp_mapping_enabled":{"$ref":"#/components/schemas/IDPMappingEnabled"},"oidc_issuer":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"string","deprecated":true},"oidc_client_id":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"string","deprecated":true},"oidc_client_secret":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"string","deprecated":true},"oidc_scopes":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"array","items":{"type":"string","default":"openid"},"default":["email","openid","profile"],"deprecated":true},"oidc_claim_mappings":{"description":"Deprecated. Use the [Identity Provider API](https://developer.konghq.com/api/konnect/portal-management/v3/#/operations/update-portal-identity-provider) instead.","type":"object","example":{"name":"name","email":"email","groups":"custom-group-claim"},"deprecated":true,"maxProperties":3,"minProperties":0,"properties":{"name":{"type":"string","example":"name","default":"name"},"email":{"type":"string","example":"email","default":"email"},"groups":{"type":"string","example":"custom-group-claim","default":"groups"}},"title":"PortalClaimMappings"}},"example":{"basic_auth_enabled":true,"oidc_auth_enabled":true,"oidc_team_mapping_enabled":true,"konnect_mapping_enabled":false,"oidc_issuer":"https://identity.example.com/v2","oidc_client_id":"x7id0o42lklas0blidl2","oidc_scopes":["email","openid","profile"],"oidc_claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}},"title":"PortalAuthenticationSettingsUpdateRequest"},"PortalTeamGroupMappingsUpdateRequest":{"description":"A set of mappings to update from a team to their groups.","type":"object","properties":{"data":{"description":"The IdP groups to map to the given team.","type":"array","items":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid"},"groups":{"type":"array","items":{"type":"string"}}}}}},"example":{"data":[{"team_id":"af91db4c-6e51-403e-a2bf-33d27ae50c0a","groups":["Service Developer"]}]},"title":"PortalTeamGroupMappingsUpdateRequest"},"PortalUpdateTeamRequest":{"description":"Properties to update on a team.","type":"object","properties":{"name":{"type":"string","example":"IDM - Developers","pattern":"^[\\w \\W]+$","writeOnly":true},"description":{"type":"string","example":"The Identity Management (IDM) API team.","maxLength":250,"writeOnly":true},"can_own_applications":{"description":"Whether the team is allowed to own applications.","type":"boolean","example":true}},"example":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team.","can_own_applications":false},"title":"PortalUpdateTeamRequest"},"PortalCreateTeamRequest":{"description":"Details about a team to create.","type":"object","properties":{"name":{"type":"string","example":"IDM - Developers","pattern":"^[\\w \\W]+$","writeOnly":true},"description":{"type":"string","example":"The Identity Management (IDM) team.","maxLength":250,"writeOnly":true},"can_own_applications":{"description":"Whether the team is allowed to own applications","type":"boolean","example":true,"default":false}},"example":{"name":"IDM - Developers","description":"The Identity Management (IDM) team.","can_own_applications":false},"required":["name"],"title":"PortalCreateTeamRequest"},"PortalTeamResponse":{"description":"Details about a developer team.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"type":"string","example":"IDM - Developers","maxLength":250,"pattern":"^[\\w \\W]+$"},"description":{"type":"string","example":"The developers for the IDM API.","maxLength":250},"created_at":{"type":"string","format":"date-time","example":"1992-02-07T17:46:57.52Z","readOnly":true},"updated_at":{"type":"string","format":"date-time","example":"2022-02-07T17:00:00.52Z","readOnly":true},"can_own_applications":{"description":"Whether the team is allowed to own applications.","type":"boolean","example":false}},"example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z","can_own_applications":false},"title":"PortalTeamResponse"},"PortalTeamGroupMappingResponse":{"description":"A paginated list of portal team group mappings.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalTeamGroupMapping"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]},{"team_id":"7301e673-cc10-498a-94cd-4271de07a0d3","groups":["Managers","Directors"]}]},"title":"PortalTeamGroupMappingResponse"},"PortalTeamGroupMapping":{"description":"A map of portal teams to Identity Provider groups.","type":"object","properties":{"team_id":{"description":"The Konnect team ID.","type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"},"groups":{"description":"The IdP groups that are mapped to the specified team.","type":"array","items":{"type":"string","example":"API Engineers"},"uniqueItems":true}},"example":{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]},"title":"PortalTeamGroupMapping"},"PortalAssignedRoleResponse":{"description":"An assigned role associates a service and an action to a team.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"eaf7adf1-32c8-4bbf-b960-d1f8456afe67"},"role_name":{"type":"string","example":"API Viewer"},"entity_id":{"type":"string","format":"uuid","example":"817d0422-45c9-4d88-8d64-45aef05c1ae7"},"entity_type_name":{"type":"string","example":"Services"},"entity_region":{"description":"Region of the entity.","type":"string","example":"eu","enum":["us","eu","au","me","in","sg","*"]}},"example":{"id":"1a3c2169-27f8-4594-926b-41df3432d5dc","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"},"required":["id","role_name","entity_id","entity_type_name","entity_region"],"title":"PortalAssignedRoleResponse"},"ListDomains":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailDomain"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"EmailDeliveryUpdatePayload":{"type":"object","properties":{"enabled":{"type":"boolean"},"from_email":{"type":"string","format":"email","nullable":true},"reply_to_email":{"type":"string","format":"email","nullable":true}},"additionalProperties":false},"EmailDelivery":{"type":"object","properties":{"enabled":{"type":"boolean"},"from_email":{"type":"string","format":"email","nullable":true},"reply_to_email":{"type":"string","format":"email","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["enabled","from_email","reply_to_email","created_at","updated_at"]},"PatchPortalEmailConfig":{"type":"object","properties":{"domain_name":{"description":"The domain name to use for sending emails. Null means default.","type":"string","nullable":true},"from_name":{"description":"The name to display in the 'From' field of emails.","type":"string","nullable":true},"from_email":{"description":"The email address to use in the 'From' field.","type":"string","format":"email","nullable":true},"reply_to_email":{"description":"The email address to use in the 'Reply-To' field. If set to null, 'Reply-To' header is omitted.","type":"string","format":"email","nullable":true}},"additionalProperties":false},"PostPortalEmailConfig":{"type":"object","properties":{"domain_name":{"description":"The domain name to use for sending emails. Null means default.","type":"string","nullable":true},"from_name":{"description":"The name to display in the 'From' field of emails.","type":"string","nullable":true},"from_email":{"description":"The email address to use in the 'From' field.","type":"string","format":"email","nullable":true},"reply_to_email":{"description":"The email address to use in the 'Reply-To' field. 'Reply-To' header is omitted if omitted or null.","type":"string","format":"email","nullable":true}},"additionalProperties":false},"PortalEmailConfig":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"domain_name":{"description":"The domain name used for sending emails. Null means default.","type":"string","nullable":true},"from_name":{"description":"The name displayed in the 'From' field of emails.","type":"string","nullable":true},"from_email":{"description":"The email address used in the 'From' field.","type":"string","format":"email","nullable":true},"reply_to_email":{"description":"The email address used in the 'Reply-To' field. 'Reply-To' header is omitted when null.","type":"string","format":"email","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","from_name","from_email","reply_to_email","created_at","updated_at"]},"EmailDomainPayload":{"type":"object","properties":{"domain":{"type":"string"}},"additionalProperties":false,"required":["domain"]},"EmailVerificationStatus":{"description":"Specifies the status of the mail domain verification","type":"string","enum":["pending","success","failed","temporary_failure","not_started"],"readOnly":true},"EmailDomainVerification":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EmailVerificationStatus"},"last_time_checked":{"description":"An ISO-8601 timestamp representation of the last time the verification got checked.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"last_time_success":{"description":"An ISO-8601 timestamp representation of the last time the verification succeeded.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"additionalProperties":false,"readOnly":true,"required":["status","last_time_checked","last_time_success"]},"DNSRecord":{"type":"object","properties":{"type":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true}},"additionalProperties":false,"required":["type","name","value"]},"EmailDomain":{"type":"object","properties":{"domain":{"type":"string"},"verification":{"$ref":"#/components/schemas/EmailDomainVerification"},"dns_validation_records":{"type":"array","items":{"$ref":"#/components/schemas/DNSRecord"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["domain","verification","dns_validation_records","created_at","updated_at"]},"EmailDomainFilterParameters":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/StringFieldFilter"},"verification_status":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"EmailDomainFilterParameters"},"EmailTemplateName":{"description":"Short name email template name.\n","type":"string","enum":["confirm-email-address","app-registration-approved","app-registration-rejected","app-registration-revoked","reset-password","account-access-approved","account-access-rejected","account-access-revoked","api-key-expiring-soon","api-key-expired","developer-invitation"]},"EmailTemplateVariableName":{"description":"Enum for available portal email template variables.\n","type":"string","enum":["portal_display_name","portal_domain","developer_email","developer_fullname","dev_portal_reply_to","developer_status","api_documentation_url","api_name","api_version","application_name","credential_name","credential_expires_at"]},"DefaultEmailTemplate":{"type":"object","properties":{"default_content":{"$ref":"#/components/schemas/DefaultEmailTemplateContent"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateVariableName"}},"name":{"$ref":"#/components/schemas/EmailTemplateName"},"label":{"description":"The label of the email template","type":"string","example":"Confirm email Address"}},"additionalProperties":false,"required":["default_content","variables","name","label"]},"DefaultEmailTemplateContent":{"type":"object","properties":{"subject":{"type":"string","nullable":false},"title":{"type":"string","nullable":false},"body":{"type":"string","nullable":false},"button_label":{"type":"string","nullable":false}},"required":["subject","title","body"]},"EmailTemplateContent":{"type":"object","properties":{"subject":{"type":"string","maxLength":1024,"nullable":true},"title":{"type":"string","maxLength":1024,"nullable":true},"body":{"type":"string","maxLength":4096,"nullable":true},"button_label":{"type":"string","maxLength":128,"nullable":true}},"nullable":true},"SendTestEmailTemplateContent":{"type":"object","properties":{"subject":{"type":"string","maxLength":1024,"nullable":false},"title":{"type":"string","maxLength":1024,"nullable":false},"body":{"type":"string","maxLength":4096,"nullable":false},"button_label":{"type":"string","maxLength":128,"nullable":false}},"required":["subject","title","body"]},"EmailTemplate":{"type":"object","properties":{"label":{"description":"The label of the email template","type":"string","example":"App registration approved"},"name":{"$ref":"#/components/schemas/EmailTemplateName"},"default_content":{"$ref":"#/components/schemas/DefaultEmailTemplateContent"},"content":{"$ref":"#/components/schemas/EmailTemplateContent"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateVariableName"}},"enabled":{"description":"Whether the email template is enabled or disabled for a portal","type":"boolean"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["name","label","default_content","variables","enabled","created_at","updated_at"]},"EmailTemplateVariablesList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateVariable"}}},"additionalProperties":false},"EmailTemplateVariable":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/EmailTemplateVariableName"},"description":{"type":"string"},"scope":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateName"}},"example":{"description":"Example value of the email template variable","type":"string","example":"My Company Portal"}},"required":["name","description","scope","example"]},"FilterApplications":{"type":"object","properties":{"developer_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"team_id":{"$ref":"#/components/schemas/UuidFieldFilter"}}},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","properties":{"eq":{"type":"string"}},"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"BooleanFieldFilter":{"description":"Filter by a boolean value (true/false).","type":"boolean","title":"BooleanFieldFilter","x-examples":{"example-1":true}},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"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},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"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"},"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"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"LabelsUpdate":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nLabels are intended to store **INTERNAL** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63,"nullable":true},"maxProperties":50,"nullable":true,"writeOnly":true},"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"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"ImagePNGDataUri":{"description":"must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/png,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImagePNGDataUri","x-validation-message":"must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>"},"ImageJPGDataUri":{"description":"must be a data URL with base64 JPEG image data, e.g., data:image/jpeg;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/jpeg,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/jpeg(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageJPGDataUri","x-validation-message":"must be a data URL with base64 JPEG image data, e.g., data:image/jpeg;base64,<BASE64_IMAGE_DATA>"},"ImageGIFDataUri":{"description":"must be a data URL with base64 GIF image data, e.g., data:image/gif;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/gif,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/gif(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageGIFDataUri","x-validation-message":"must be a data URL with base64 GIF image data, e.g., data:image/gif;base64,<BASE64_IMAGE_DATA>"},"ImageICODataUri":{"description":"must be a data URL with base64 ICO image data, e.g., data:image/ico;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/ico,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/(x-icon|ico|icon|vnd.microsoft.icon)(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageICODataUri","x-validation-message":"must be a data URL with base64 ICO image data, e.g., data:image/ico;base64,<BASE64_IMAGE_DATA>"},"ImageSVGDataUri":{"description":"must be a data URL with base64 SVG image data, e.g., data:image/svg\\+xml;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/svg+xml,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/svg\\+xml(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageSVGDataUri","x-validation-message":"must be a data URL with base64 SVG image data, e.g., data:image/svg\\+xml;base64,<BASE64_IMAGE_DATA>"},"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},"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"},"GoogleTagManagerIntegrationConfigProperties":{"description":"Configuration data for the Google Tag Manager integration","type":"object","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}},"additionalProperties":false},"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"]},"GoogleAnalytics4IntegrationConfigProperties":{"description":"Configuration data for the Google Analytics integration","type":"object","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}},"additionalProperties":false},"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"]},"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"},"UpdateGoogleTagManagerIntegration":{"description":"Partially update 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":{"type":"object","$ref":"#/components/schemas/GoogleTagManagerIntegrationConfigProperties"}},"additionalProperties":false,"nullable":true},"UpdateGoogleAnalytics4Integration":{"description":"Partially update Google Analytics 4 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":{"type":"object","$ref":"#/components/schemas/GoogleAnalytics4IntegrationConfigProperties"}},"additionalProperties":false,"nullable":true},"UpdatePortalIntegrations":{"description":"Partially update configuration data for Dev Portal integrations","type":"object","properties":{"google_tag_manager":{"$ref":"#/components/schemas/UpdateGoogleTagManagerIntegration"},"google_analytics_4":{"$ref":"#/components/schemas/UpdateGoogleAnalytics4Integration"}},"default":{},"additionalProperties":false,"title":"Update Portal Integrations"},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"AuthMethods":{"type":"array","items":{"description":"Auth Methods enabled for this strategy","type":"string"},"example":["bearer"]},"AvailableScopes":{"description":"Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.","type":"array","items":{"type":"string"},"example":["scope1","scope2"]},"AuthStrategyClientCredentials":{"description":"Client Credential Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["client_credentials","self_managed_client_credentials"]},"auth_methods":{"$ref":"#/components/schemas/AuthMethods"},"available_scopes":{"$ref":"#/components/schemas/AvailableScopes"}},"additionalProperties":false,"required":["id","name","credential_type","auth_methods"]},"ApplicationOwnerType":{"description":"The type of the owner of the application. Can be `developer` (individual developer) or `team`.","type":"string","enum":["developer","team"]},"ApplicationOwnerId":{"description":"The ID of the owner of the application. When type is `developer`, this is the developer ID. When type is `team`, this is the team ID.","type":"string","format":"uuid"},"ApplicationOwner":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ApplicationOwnerType"},"id":{"$ref":"#/components/schemas/ApplicationOwnerId"}},"additionalProperties":false,"required":["type","id"]},"AuthStrategyKeyAuth":{"description":"KeyAuth Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["key_auth"]},"key_names":{"type":"array","items":{"type":"string"}},"ttl":{"description":"Default maximum Time-To-Live for keys created under this strategy.","type":"object","properties":{"value":{"type":"integer","minimum":1},"unit":{"type":"string","enum":["days","weeks","years"]}},"required":["value","unit"]}},"additionalProperties":false,"required":["id","name","credential_type","key_names"]},"ApiKeyCredentialListItem":{"description":"API key credential returned when listing credentials.","type":"object","properties":{"type":{"type":"string","enum":["api_key"],"readOnly":true},"id":{"$ref":"#/components/schemas/UUID"},"display_name":{"type":"string"},"status":{"type":"string","enum":["active","expired","revoked"],"readOnly":true},"expires_at":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"additionalProperties":false,"required":["type","id","display_name","created_at"]},"ClientSecretCredentialListItem":{"description":"Client secret credential returned when listing credentials.","type":"object","properties":{"type":{"type":"string","enum":["client_secret"],"readOnly":true},"id":{"description":"Credential identifier","type":"string"},"display_name":{"description":"May not be available for all Client Credentials applications","type":"string","nullable":true},"client_id":{"description":"OAuth2 client identifier","type":"string","readOnly":true},"created_at":{"description":"Creation timestamp, if available","type":"string","format":"date-time","nullable":true,"readOnly":true},"expires_at":{"description":"Expiration timestamp, if applicable","type":"string","format":"date-time","nullable":true,"readOnly":true}},"additionalProperties":false,"required":["type","id","client_id","created_at"]},"CredentialListItem":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ApiKeyCredentialListItem"},{"$ref":"#/components/schemas/ClientSecretCredentialListItem"}]},"ListCredentialsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CredentialListItem"}}},"additionalProperties":false,"required":["data","meta"]},"EntityType":{"description":"The type of entity that is being published. Can be either an API or an API Package.","type":"string","example":"api","enum":["api","api_package"],"title":"Entity Type"},"IdentityProviderType":{"description":"Specifies the type of identity provider.","type":"string","example":"oidc","enum":["oidc","saml"]},"IdentityProviderEnabled":{"description":"Indicates whether the identity provider is enabled.\nOnly one identity provider can be active at a time, such as SAML or OIDC.\n","type":"boolean","example":true,"default":false,"title":"Identity Provider Enabled Property"},"OIDCIdentityProviderIssuer":{"description":"The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.","type":"string","format":"uri","example":"https://konghq.okta.com/oauth2/default","title":"OIDC Identity Provider Issuer Property"},"OIDCIdentityProviderClientId":{"description":"The client ID assigned to your application by the identity provider.","type":"string","example":"YOUR_CLIENT_ID","title":"OIDC Identity Provider Login Client Id Property"},"OIDCIdentityProviderClientSecret":{"description":"The Client Secret assigned to your application by the identity provider.","type":"string","example":"YOUR_CLIENT_SECRET","title":"OIDC Identity Provider Login Client Secret Property","writeOnly":true},"OIDCIdentityProviderScopes":{"description":"The scopes requested by your application when authenticating with the identity provider.","type":"array","items":{"type":"string"},"default":["email","openid","profile"],"title":"OIDC Identity Provider Scopes Property"},"OIDCIdentityProviderClaimMappings":{"description":"Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for \nauthentication.\n","type":"object","properties":{"name":{"description":"The claim mapping for the user's name.","type":"string","example":"name","default":"name"},"email":{"description":"The claim mapping for the user's email address.","type":"string","example":"email","default":"email"},"groups":{"description":"The claim mapping for the user's group membership information.","type":"string","example":"groups","default":"groups"}},"title":"OIDC Claim Mappings"},"OIDCIdentityProviderConfig":{"description":"The identity provider that contains configuration data for the OIDC authentication integration.","type":"object","properties":{"issuer_url":{"$ref":"#/components/schemas/OIDCIdentityProviderIssuer"},"client_id":{"$ref":"#/components/schemas/OIDCIdentityProviderClientId"},"client_secret":{"$ref":"#/components/schemas/OIDCIdentityProviderClientSecret"},"scopes":{"$ref":"#/components/schemas/OIDCIdentityProviderScopes"},"claim_mappings":{"$ref":"#/components/schemas/OIDCIdentityProviderClaimMappings"}},"additionalProperties":false,"required":["issuer_url","client_id"],"title":"OIDC Identity Provider Config"},"SAMLIdentityProviderMetadataURL":{"description":"The identity provider's metadata URL where the identity provider's metadata can be obtained.","type":"string","format":"uri","example":"https://mocksaml.com/api/saml/metadata","title":"SAML Identity Provider Metadata URL"},"SAMLIdentityProviderMetadata":{"description":"The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the `idp_metadata_url` field instead.\n","type":"string","example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<EntityDescriptor xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\">\n  <!-- SAML metadata content here -->\n</EntityDescriptor>\n","title":"SAML Identity Provider Metadata"},"SAMLIdentityProviderConfig":{"description":"The identity provider that contains configuration data for the SAML authentication integration.","type":"object","properties":{"idp_metadata_url":{"$ref":"#/components/schemas/SAMLIdentityProviderMetadataURL"},"idp_metadata_xml":{"$ref":"#/components/schemas/SAMLIdentityProviderMetadata"},"sp_metadata_url":{"type":"string","format":"path","example":"/api/v2/developer/authenticate/saml/metadata","readOnly":true},"sp_entity_id":{"description":"The entity ID of the service provider (SP).","type":"string","example":"https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000","readOnly":true},"callback_url":{"description":"The path URL where the SAML identity provider sends authentication responses after successful login attempts.","type":"string","format":"path","example":"/api/v2/developer/authenticate/saml/acs","readOnly":true}},"additionalProperties":false,"title":"SAML Identity Provider Config"},"IdentityProvider":{"description":"The identity provider that contains configuration data for authentication integration.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"enabled":{"$ref":"#/components/schemas/IdentityProviderEnabled"},"config":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OIDCIdentityProviderConfig"},{"$ref":"#/components/schemas/SAMLIdentityProviderConfig"}]},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"title":"Identity Provider"},"CreateIdentityProvider":{"description":"The identity provider that contains configuration data for creating an authentication integration.","type":"object","properties":{"enabled":{"$ref":"#/components/schemas/IdentityProviderEnabled"},"type":{"$ref":"#/components/schemas/IdentityProviderType"},"config":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OIDCIdentityProviderConfig"},{"$ref":"#/components/schemas/SAMLIdentityProviderConfig"}]}},"title":"Identity Provider"},"UpdateIdentityProvider":{"description":"The identity provider that contains configuration data for updating an authentication integration.","type":"object","properties":{"enabled":{"$ref":"#/components/schemas/IdentityProviderEnabled"},"config":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OIDCIdentityProviderConfig"},{"$ref":"#/components/schemas/SAMLIdentityProviderConfig"}]}},"title":"Identity Provider"},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"PortalAllowedIPs":{"description":"The list of allowed ips for the portal.","type":"array","items":{"type":"string"},"example":["192.168.1.1","192.168.1.0/22"],"maxItems":25,"minItems":1,"uniqueItems":true},"IPEntry":{"description":"An entry representing a collection of allowed IP addresses or CIDR blocks.","type":"object","properties":{"id":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":false},"allowed_ips":{"$ref":"#/components/schemas/PortalAllowedIPs"}},"additionalProperties":false,"required":["id","allowed_ips"]},"IPEntries":{"description":"The list of allowed ips for the portal.","type":"array","items":{"$ref":"#/components/schemas/IPEntry"},"example":[{"id":"660e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.1"]},{"id":"550e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.0/22","192.168.1.52"]}],"maxItems":1000,"uniqueItems":true}},"examples":{"400-request-format-is-invalid":{"value":{"status":400,"title":"Bad Request","detail":"Could not parse request body","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400-authorization-cannot-be-blank":{"value":{"status":400,"title":"Bad Request","detail":"Required field missing","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"authorization","reason":"cannot be blank"}]}},"400-endpoint-cannot-be-blank":{"value":{"status":400,"title":"Bad Request","detail":"Required field missing","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"endpoint","reason":"cannot be blank"}]}},"400-endpoint-must-be-valid-url":{"value":{"status":400,"title":"Bad Request","detail":"Invalid endpoint","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"endpoint","reason":"must be a valid URL"}]}},"409-job-running":{"value":{"status":409,"title":"Resource Conflict","instance":"konnect:trace:6644808935508571943","detail":"A replay job is currently running"}},"ListDevelopersExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":4}},"data":[{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jane.developer@example.com","full_name":"Jane Dev","status":"approved","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"4cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"John Dev","status":"revoked","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"Jim Dev","status":"pending","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"},{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"Jan Dev","status":"rejected","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}]}},"GetDeveloperExample1":{"value":{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}},"Update-Portal-Audit-Log-Webhook":{"value":{"audit_log_destination_id":"9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"}},"Disable-Portal-Audit-Log-Webhook":{"value":{"enabled":false}},"Enable-Portal-Audit-Log-Webhook":{"value":{"enabled":true}},"Get-Portal-Audit-Log-Webhook":{"value":{"enabled":true,"audit_log_destination_id":"9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"}},"Get-Portal-Audit-Log-Webhook-Status":{"value":{"webhook_enabled":true,"webhook_status":"inactive","last_attempt_at":"2023-03-21T09:29:14.52Z","last_response_code":401,"last_response_message":"Unauthorized"}},"UpdateTeamExample1":{"value":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team.","can_own_applications":true}},"CreateTeamExample1":{"value":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team.","can_own_applications":true}},"AddDeveloperToTeamExample1":{"value":{"id":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"}},"UpdatePortalTeamGroupMappingsExample1":{"value":{"data":[{"team_id":"af91db4c-6e51-403e-a2bf-33d27ae50c0a","groups":["Service Developer"]},{"team_id":"bc11db4c-6e51-403e-a2bf-33d27ae50c0a","groups":["Service Owner"]}]}},"PortalExample1":{"value":{"id":"9f9fd312-a987-4628-b4c5-bb4f4fddd5f7","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","name":"Portal A","display_name":"Developer Portal A","description":"The Portal A","default_domain":"123455678abcd.us.portal.konghq.com","authentication_enabled":false,"rbac_enabled":true,"sipr_enabled":false,"default_api_visibility":"private","default_page_visibility":"private","default_application_auth_strategy_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","auto_approve_applications":false,"auto_approve_developers":true,"canonical_domain":"api.example.com"}},"UpdatePortalExampleRbacEnabled":{"value":{"authentication_enabled":true,"rbac_enabled":true}},"UpdatePortalExampleAuthenticationDisabled":{"value":{"authentication_enabled":false}},"UpdatePortalExampleAutoApprove":{"value":{"auto_approve_applications":true,"auto_approve_developers":true}},"UpdatePortalExample1":{"value":{"authentication_enabled":false,"rbac_enabled":false,"auto_approve_applications":false,"auto_approve_developers":false}},"CreatePortalExampleRbacEnabled":{"value":{"name":"MyDevPortal","authentication_enabled":true,"rbac_enabled":true}},"CreatePortalExampleAuthenticationDisabled":{"value":{"name":"MyDevPortal","authentication_enabled":false}},"CreatePortalExampleAutoApprove":{"value":{"name":"MyDevPortal","auto_approve_applications":true,"auto_approve_developers":true}},"CreatePortalExample1":{"value":{"name":"MyDevPortal","authentication_enabled":true,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":false}},"ListPortalsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":1}},"data":[{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f7","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","name":"Portal A","display_name":"Developer Portal A","description":"The Portal A","authentication_enabled":false,"rbac_enabled":true,"sipr_enabled":false,"default_api_visibility":"private","default_page_visibility":"private","default_application_auth_strategy_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","auto_approve_applications":false,"auto_approve_developers":true,"default_domain":"123455678abcd.edge.us.portal.konghq.com","canonical_domain":"123455678abcd.edge.us.portal.konghq.com"}]}},"ListPortalsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListPortalsBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListPortalsBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["created_at","updated_at"],"reason":"must be one of [created_at, updated_at]","source":"query"}]}},"UpdatePortalBadRequestExample1":{"summary":"Unknown property","value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdatePortalBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"authentication_enabled","rule":"is_boolean","reason":"value of \"authentication_enabled\" must be true or false","source":"body"}]}},"UpdatePortalBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"rbac_enabled","rule":"is_boolean","reason":"value of \"rbac_enabled\" must be true or false","source":"body"}]}},"UpdatePortalBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"auto_approve_applications","rule":"is_boolean","reason":"value of \"auto_approve_applications\" must be true or false","source":"body"}]}},"UpdatePortalBadRequestExample5":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"auto_approve_developers","rule":"is_boolean","reason":"value of \"auto_approve_developers\" must be true or false","source":"body"}]}},"UpdatePortalCustomizationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"ReplacePortalCustomizationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdatePortalIntegrationsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"ReplacePortalIntegrationsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"ReplacePortalImageAssetExample1":{"value":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}},"ReplacePortalImageAssetBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"data","rule":"required","reason":"data is required","source":"body"}]}},"CreatePortalPageExample1":{"value":{"title":"Getting Started","slug":"/getting-started","content":"Welcome to the Getting Started page. This is where you can learn how to use our APIs.","visibility":"public","status":"published"}},"UpdatePortalPageExample1":{"value":{"title":"About Us","slug":"/about-us","content":"Welcome to the About Us page. This is where you can learn about our company."}},"PortalPageExample1":{"value":{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f7","slug":"/","title":"Home","content":"Welcome to the home page of the portal. This is where you can find information about the portal and its APIs.","visibility":"public","status":"published","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","parent_page_id":null}},"DefaultContentExample1":{"value":{"pages":["/about","/home","/privacy"],"snippets":["guides-sidebar-navigation","guides-sidebar-toc"]}},"ListPortalPagesExample1":{"value":{"data":[{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f7","slug":"/","title":"Home","visibility":"public","status":"published","description":"A custom page","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z","parent_page_id":null,"children":[]}]}},"ListPortalPagesBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"UpdatePortalPageBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdatePortalPageBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"title","rule":"max_length","reason":"value of \"title\" must not exceed 512 characters","source":"body","maximum":512}]}},"CreatePortalSnippetExample1":{"value":{"title":"Getting Started","name":"getting-started","content":"Welcome to the Getting Started page. This is where you can learn how to use our APIs.","visibility":"public","status":"published"}},"UpdatePortalSnippetExample1":{"value":{"title":"About Us","name":"about-us","content":"Welcome to the About Us page. This is where you can learn about our company."}},"PortalSnippetExample1":{"value":{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"snip1","title":"Home","content":"Welcome to the first snippet of the portal.","visibility":"public","status":"published","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}},"ListPortalSnippetsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":1}},"data":[{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"snip1","title":"Home","visibility":"public","status":"published","description":"A custom snippet","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}]}},"ListPortalSnippetsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListPortalSnippetsBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"UpdatePortalSnippetBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdatePortalSnippetBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"title","rule":"max_length","reason":"value of \"title\" must not exceed 512 characters","source":"body","maximum":512}]}},"ListApplicationsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":2,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"85606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"},{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"A Konnect application that is linked to an Identity Provider application using Dynamic Client Registration (DCR)","client_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":3,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"65606071-49c7-4c2e-ae49-8a86d72a8110","name":"Client Credentials","credential_type":"client_credentials","auth_methods":["client_credentials","bearer","session"]},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":null,"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z"}]}},"GetApplicationExampleBasic":{"value":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}},"GetApplicationExampleDcr":{"value":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"A Konnect application that is linked to an Identity Provider application, where the relationship is managed by Konnect using Dynamic Client Registration (DCR)","client_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":1,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"Client Credentials","credential_type":"client_credentials","auth_methods":["client_credentials"]},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":["openid"],"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}},"GetApplicationExampleOIDC":{"value":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"A Konnect application that is linked to an Identity Provider application by client_id, but the relationship is not managed by Konnect through DCR","client_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":1,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"Client Credentials","credential_type":"self_managed_client_credentials","auth_methods":["client_credentials"]},"dcr_provider":null,"granted_scopes":null,"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}},"ListApplicationDevelopersExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":4}},"data":[{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jane.developer@example.com","full_name":"Jane Dev"},{"id":"4cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"john.developer@example.com","full_name":"John Dev"},{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jim.developer@example.com","full_name":"Jim Dev"},{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"jan.developer@example.com","full_name":"Jan Dev"}]}},"ListApplicationRegistrationsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"c200cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d200cc33-2d33-4754-b086-a98e0fcd36fb","status":"rejected","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 2"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v2","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d300cc33-2d33-4754-b086-a98e0fcd36fb","status":"pending","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 3"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Stuff","version":"v2","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"},{"id":"d300cc33-2d33-4754-b086-a98e0fcd36fb","status":"revoked","application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 3"},"api":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}]}},"GetApplicationRegistrationExample1":{"value":{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}},"UpdateApplicationRegistrationResponseExample1":{"value":{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}},"ListApplicationsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListApplicationsBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListApplicationsBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["created_at","developer_id","name"],"reason":"must be one of [created_at, developer_id, name]","source":"query"}]}},"ListApplicationsBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"ListApplicationRegistrationsByPortalBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListApplicationRegistrationsByPortalBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListApplicationRegistrationsByPortalBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["created_at","updated_at","developer_id","status"],"reason":"must be one of [created_at, updated_at, developer_id, status]","source":"query"}]}},"ListApplicationRegistrationsByPortalBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"ListRegistrationsByApplicationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListRegistrationsByApplicationBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListRegistrationsByApplicationBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["created_at","updated_at","status"],"reason":"must be one of [created_at, updated_at, status]","source":"query"}]}},"ListRegistrationsByApplicationBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"ListDevelopersByApplicationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListDevelopersByApplicationBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListDevelopersByApplicationBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["id"],"reason":"must be one of [status]","source":"query"}]}},"ListDevelopersByApplicationBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"UpdateApplicationRegistrationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdateApplicationRegistrationApproved":{"value":{"status":"approved"}},"UpdateApplicationRegistrationPending":{"value":{"status":"pending"}},"UpdateApplicationRegistrationRejected":{"value":{"status":"rejected"}},"UpdateApplicationRegistrationRevoked":{"value":{"status":"revoked"}},"UpdateDeveloperExampleApproved":{"value":{"status":"approved"}},"UpdateDeveloperExamplePending":{"value":{"status":"pending"}},"UpdateDeveloperExampleRejected":{"value":{"status":"rejected"}},"UpdateDeveloperExampleRevoked":{"value":{"status":"revoked"}},"PortalTeamGroupMappingCollectionExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]},{"team_id":"7301e673-cc10-498a-94cd-4271de07a0d3","groups":["Managers","Directors"]}]}},"PortalAuthenticationSettingsExample1":{"value":{"basic_auth_enabled":true,"oidc_auth_enabled":true,"saml_auth_enabled":true,"oidc_team_mapping_enabled":true,"konnect_mapping_enabled":true,"idp_mapping_enabled":true,"oidc_config":{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}}},"PortalAssignedRoleUSExample":{"value":{"id":"1a3c2169-27f8-4594-926b-41df3432d5dc","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}},"PortalAssignedRoleAllRegionsExample":{"value":{"id":"034cb810-1f2d-40d2-a1ce-31944144668e","role_name":"API Consumer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"*"}},"PortalTeamExample1":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Gold Tier","description":"Team with access to APIs in the Gold tier","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":false}},"AssignedPortalRoleCollectionExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":3}},"data":[{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adce","role_name":"API Viewer","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Services","entity_region":"us"},{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adce","role_name":"API Consumer","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Services","entity_region":"us"},{"id":"869d9402-f117-4f9a-840f-69acaf70a81a","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}]}},"ListPortalTeamsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":3}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Partner","description":"Team with access to Partner APIs","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":false},{"id":"af9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Internal","description":"Team with access to Internal APIs","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":true},{"id":"4f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Root","description":"Team with access to Internal Systems","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-09-25T13:00:00.00Z","can_own_applications":true}]}},"ListRolesExample1":{"value":{"services":{"name":"Services","roles":{"apiviewer":{"name":"API Viewer","description":"API Viewers have read-only access to the documentation of a service in a portal"},"apiconsumer":{"name":"API Consumer","description":"API Consumers can make calls to the given service"}}}}},"ListBasicDevelopersExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"james.woods@email.com","full_name":"James Woods","active":true,"created_at":"2022-08-17T17:46:57.52Z","updated_at":"2022-10-03T17:00:00.00Z"},{"id":"4f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"jill.stone@email.com","full_name":"Jill Stone","active":false,"created_at":"2022-07-17T17:46:57.52Z","updated_at":"2022-10-03T17:00:00.00Z"}]}},"UpdateAuthSettingsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"basic_auth_enabled","rule":"is_boolean","reason":"value of \"basic_auth_enabled\" must be true or false","source":"body"}]}},"UpdateAuthSettingsBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_auth_enabled","rule":"is_boolean","reason":"value of \"oidc_auth_enabled\" must be true or false","source":"body"}]}},"UpdateAuthSettingsBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_team_mapping_enabled","rule":"is_boolean","reason":"value of \"oidc_team_mapping_enabled\" must be true or false","source":"body"}]}},"UpdateAuthSettingsBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"konnect_mapping_enabled","rule":"is_boolean","reason":"value of \"konnect_mapping_enabled\" must be true or false","source":"body"}]}},"UpdateAuthSettingsBadRequestExample5":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_issuer","rule":"is_string","reason":"value of \"oidc_issuer\" must be a utf-8 string","source":"body"}]}},"UpdateAuthSettingsBadRequestExample6":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_client_id","rule":"is_string","reason":"value of \"oidc_client_id\" must be a utf-8 string","source":"body"}]}},"UpdateAuthSettingsBadRequestExample7":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_client_secret","rule":"is_string","reason":"value of \"oidc_client_secret\" must be a utf-8 string","source":"body"}]}},"UpdateAuthSettingsBadRequestExample8":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"oidc_scopes","rule":"is_array","reason":"\"oidc_scopes\" must be an array","source":"body"}]}},"ListTeamGroupMappingsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListTeamGroupMappingsBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"UpdateTeamGroupMappingsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"data","rule":"is_array","reason":"\"data\" must be an array","source":"body"}]}},"CreateTeamBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_attribute","rule":"required","reason":"\"my_attribute\" is required","source":"body"}]}},"CreateTeamBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"is_string","reason":"value of \"name\" must be a utf-8 string","source":"body"}]}},"CreateTeamBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"description","rule":"max_length","reason":"value of \"description\" must not exceed 250 characters","source":"body","maximum":250}]}},"AddDeveloperToTeamBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_attribute","rule":"required","reason":"\"my_attribute\" is required","source":"body"}]}},"AddDeveloperToTeamBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"id","rule":"is_uuid","reason":"value of \"id\" must be a UUID","source":"body"}]}},"AssignRoleBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"role_name","rule":"is_string","reason":"value of \"role_name\" must be a utf-8 string","source":"body"}]}},"AssignRoleBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"entity_id","rule":"is_uuid","reason":"value of \"entity_id\" must be a UUID","source":"body"}]}},"AssignRoleBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"entity_type_name","rule":"is_string","reason":"value of \"entity_type_name\" must be a utf-8 string","source":"body"}]}},"AssignRoleBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"entity_region","rule":"enum","choices":["us","eu","au","me","in","*"],"reason":"must be one of [us, eu, au, me, in, sg, *]","source":"body"}]}},"ListDevelopersBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[size]","rule":"is_number","reason":"\"page[size]\" must be a number","source":"query"}]}},"ListDevelopersBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"page[number]","rule":"is_number","reason":"\"page[number]\" must be a number","source":"query"}]}},"ListDevelopersBadRequestExample3":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["created_at","updated_at","email","name","status"],"reason":"must be one of [created_at, updated_at, email, name, status]","source":"query"}]}},"ListDevelopersBadRequestExample4":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[my_attribute]","rule":"unknown_property","reason":"\"filter[my_attribute]\" is not allowed","source":"query"}]}},"UpdateDeveloperResponseExample1":{"value":{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}},"UpdateDeveloperBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"my_property","rule":"unknown_property","reason":"\"my_property\" is not allowed","source":"body"}]}},"UpdatePortalAuthenticationSettingsExample1":{"value":{"basic_auth_enabled":true,"oidc_auth_enabled":true,"saml_auth_enabled":true,"oidc_team_mapping_enabled":true,"konnect_mapping_enabled":false,"idp_mapping_enabled":true,"oidc_issuer":"https://identity.example.com/v2","oidc_client_id":"x7id0o42lklas0blidl2","oidc_scopes":["email","openid","profile"],"oidc_claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}},"UpdatePortalAuthenticationSettingsExampleDisableBasicAuth":{"value":{"basic_auth_enabled":false}},"UpdatePortalAuthenticationSettingsExampleEnableOIDC":{"value":{"oidc_auth_enabled":true,"oidc_team_mapping_enabled":false,"konnect_mapping_enabled":true,"oidc_issuer":"https://identity.example.com/v2","oidc_client_id":"x7id0o42lklas0blidl2","oidc_scopes":["email","openid","profile"],"oidc_claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}},"UpdatePortalAuthenticationSettingsExampleEnableOIDCTeamMapping":{"value":{"oidc_team_mapping_enabled":true,"konnect_mapping_enabled":true,"oidc_claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}},"PortalAssignRoleExampleViewer":{"value":{"role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}},"PortalAssignRoleExampleConsumer":{"value":{"role_name":"API Consumer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}},"PortalEmailConfigExample":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","domain_name":"example.com","from_name":"Gandalf","from_email":"user@example.com","reply_to_email":"admin@example.com","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"EmailTemplateExample1":{"value":{"name":"confirm-email-address","default_content":{"subject":"Confirm Your Email Address","title":"Confirm Your Email Address","body":"Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by clicking the link below:","button_label":"Confirm Email Address"},"label":"Confirm Email Address","content":{"subject":"Confirm Your Email Address","title":"Confirm Your Email Address","body":"Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by clicking the link below:\\n\\n{{ confirmation_link }}\\n\\nBest regards,\\nThe {{ portal.name }} Team","button_label":null},"variables":["developer_email","developer_fullname"],"enabled":true,"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}},"ListEmailTemplateExample1":{"value":{"data":[{"name":"confirm-email-address","default_content":{"subject":"Confirm Your Email Address","title":"Confirm Your Email Address","body":"Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by clicking the link below:","button_label":"Confirm Email Address"},"label":"Confirm Email Address","content":{"subject":"Confirm Your Email Address","title":"Confirm Your Email Address","body":"Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by clicking the link below:\\n\\n{{ confirmation_link }}\\n\\nBest regards,\\nThe {{ portal.name }} Team","button_label":null},"variables":["developer_email","developer_fullname"],"enabled":true,"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}]}},"EmailTemplateVariable1":{"value":{"data":[{"name":"portal_display_name","scope":["app-registration-approved","app-registration-rejected","app-registration-revoked","confirm-email-address","account-access-approved","reset-password","account-access-rejected","account-access-revoked"],"description":"The name of the portal","example":"KongAirlines"},{"name":"api_name","scope":["app-registration-approved","app-registration-rejected","app-registration-revoked"],"description":"The name of the API","example":"Billing"},{"name":"api_version","scope":["app-registration-approved","app-registration-rejected","app-registration-revoked"],"description":"The version of the API","example":"v1.0"}]}},"ListDefaultEmailTemplatesExample1":{"value":{"data":[{"name":"confirm-email-address","default_content":{"subject":"Confirm Your Email Address","title":"Confirm Your Email Address","body":"Hello {{ developer_fullname }},\\n\\nPlease confirm your email address by clicking the link below:","button_label":"Confirm Email Address"},"variables":["developer_email","developer_fullname"],"label":"Confirm the developer's email address"},{"name":"reset-password","default_content":{"subject":"Reset Your Password","title":"Reset Your Password","body":"Hello {{ developer_fullname }},\\n\\nPlease reset your password by clicking the link below:","button_label":"Reset Password"},"variables":["developer_email","developer_fullname"],"label":"Reset the developer's password"}]}},"GetDefaultEmailTemplateExample1":{"value":{"name":"app-registration-revoked","variables":["developer_fullname"],"label":"Inform the developer their approved app registration has been revoked by a portal admin","default_content":{"subject":"Your registration has been revoked","title":"Revoked registration","body":"Hello {{ developer_fullname }},\\n\\your registration has been revoked.","button_label":""}}},"PatchEmailTemplateResponseExample1":{"value":{"name":"app-registration-revoked","variables":["developer_fullname"],"label":"Inform the developer their approved app registration has been revoked by a portal admin","enabled":true,"created_at":"2025-12-22T20:13:07.305Z","updated_at":"2025-12-22T20:13:36.710Z","default_content":{"subject":"Your registration has been revoked","title":"Revoked registration","body":"Hello {{ developer_fullname }},\\n\\your registration has been revoked.","button_label":""},"content":{"subject":"{{developer_fullname}}, Your registration has been revoked","title":"Revoked registration","body":"Hello {{ developer_fullname }},\\n\\your registration has been **revoked**.","button_label":"Acknowledge"}}},"UpdateCustomPortalTemplateEnabled":{"value":{"enabled":true}},"UpdateCustomPortalTemplateContent":{"value":{"content":{"subject":"{{developer_fullname}}, Your registration has been revoked","title":"Revoked registration","body":"Hello {{ developer_fullname }},\\n\\your registration has been **revoked**.","button_label":"Acknowledge"}}},"PatchPortalEmailConfigExample":{"value":{"domain_name":"example.com","from_name":"Gandalf","from_email":"user@example.com","reply_to_email":"admin@example.com"}},"PostPortalEmailConfigExample":{"value":{"domain_name":"example.com","from_name":"Gandalf","from_email":"user@example.com","reply_to_email":"admin@example.com"}},"SendTestEmailTemplateExample":{"value":{"content":{"subject":"{{developer_fullname}}, Your registration has been revoked","title":"Revoked registration","body":"Hello {{ developer_fullname }},\\n\\your registration has been **revoked**.","button_label":"Acknowledge"}}},"PortalCustomDomainExample1":{"value":{"hostname":"example.com","enabled":true,"created_at":"2025-12-22T20:13:07.305Z","updated_at":"2025-12-22T20:13:07.305Z","cname_status":"pending","ssl":{"verification_status":"verified","domain_verification_method":"http"}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ListApiKeyCredentialsExample":{"value":{"data":[{"type":"api_key","id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","display_name":"My API Key","status":"active","expires_at":"2025-12-31T23:59:59.000Z","created_at":"2025-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":10,"total":1}}}},"ListClientSecretCredentialsExample":{"value":{"data":[{"type":"client_secret","id":"6e5f4d3c-2b1a-0987-6543-210fedcba987","display_name":null,"client_id":"12345678-abcd-efgh-ijkl-mnopqrstuvwx","created_at":"2024-01-15T10:30:00.000Z"}],"meta":{"page":{"number":1,"size":10,"total":1}}}},"IdentityProviders":{"value":[{"id":"a2c3156d-ebb1-432b-b2f1-edcc5f133c60","type":"saml","enabled":true,"config":{"idp_metadata_url":"https://mocksaml.com/api/saml/metadata","sp_entity_id":"https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000","sp_metadata_url":"/api/v2/developer/authenticate/saml/metadata","callback_url":"/api/v2/developer/authenticate/saml/acs"},"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:46:57.52Z"},{"id":"66da2d42-469d-48cd-9ff3-0db135dd82d8","type":"oidc","enabled":false,"config":{"issuer_url":"https://konghq.okta.com/oauth2/default","client_id":"0oaqhb43ckTZ02j1F357","scopes":["openid","email","profile"],"claim_mappings":{"email":"email","name":"name","groups":"groups"}},"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:46:57.52Z"}]},"CreateOIDCIdentityProvider":{"value":{"type":"oidc","config":{"issuer_url":"https://konghq.okta.com/oauth2/default","client_id":"0oaqhb43ckTZ02j1F357","client_secret":"BbqwI8xP9E4evOK","scopes":["openid","email","profile"],"claim_mappings":{"email":"email","name":"name","groups":"groups"}}}},"CreateSAMLIdentityProviderWithMetadataURL":{"value":{"type":"saml","config":{"idp_metadata_url":"https://mocksaml.com/api/saml/metadata"}}},"CreateSAMLIdentityProviderWithMetadata":{"value":{"type":"saml","config":{"idp_metadata_xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<EntityDescriptor xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\">\n<!-- SAML metadata content here -->\n</EntityDescriptor>\n"}}},"OIDCIdentityProvider":{"value":{"id":"66da2d42-469d-48cd-9ff3-0db135dd82d8","type":"oidc","enabled":false,"config":{"issuer_url":"https://konghq.okta.com/oauth2/default","client_id":"0oaqhb43ckTZ02j1F357","scopes":["openid","email","profile"],"claim_mappings":{"email":"email","name":"name","groups":"groups"}},"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:46:57.52Z"}},"SAMLIdentityProvider":{"value":{"id":"a2c3156d-ebb1-432b-b2f1-edcc5f133c60","type":"saml","enabled":true,"config":{"idp_metadata_url":"https://mocksaml.com/api/saml/metadata","sp_entity_id":"https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000","sp_metadata_url":"/api/v2/developer/authenticate/saml/metadata","callback_url":"/api/v2/developer/authenticate/saml/acs"},"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:46:57.52Z"}},"SAMLIdentityProviderWithMetadata":{"value":{"id":"a2c3156d-ebb1-432b-b2f1-edcc5f133c60","type":"saml","enabled":true,"config":{"idp_metadata_xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<EntityDescriptor xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\">\n<!-- SAML metadata content here -->\n</EntityDescriptor>\n","sp_entity_id":"https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000","sp_metadata_url":"/api/v2/developer/authenticate/saml/metadata","callback_url":"/api/v2/developer/authenticate/saml/acs"},"created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:46:57.52Z"}},"UpdateOIDCIdentityProvider":{"value":{"enabled":true,"config":{"issuer_url":"https://konghq.okta.com/oauth2/default","client_id":"0oaqhb43ckTZ02j1F357","client_secret":"BbqwI8xP9E4evOK","scopes":["openid","email","profile"],"claim_mappings":{"email":"email","name":"name","groups":"groups"}}}},"UpdateSAMLIdentityProvider":{"value":{"enabled":true,"config":{"idp_metadata_url":"https://mocksaml.com/api/saml/metadata"}}}},"requestBodies":{"CreatePortalCustomDomain":{"description":"Create a portal custom domain.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalCustomDomainRequest"}}}},"UpdatePortalCustomDomain":{"description":"Create a portal custom domain.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalCustomDomainRequest"}}}},"CreatePortal":{"description":"Create a portal.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the portal, used to distinguish it from other portals. Name must be unique.","type":"string","maxLength":255,"minLength":1},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","maxLength":255,"minLength":1,"nullable":false},"description":{"description":"A description of the portal.","type":"string","maxLength":512,"nullable":true},"authentication_enabled":{"description":"Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.","type":"boolean","default":true},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.","type":"boolean","default":false},"sipr_enabled":{"description":"Whether ip allow list is enabled for the portal.","type":"boolean","example":true,"default":false},"default_api_visibility":{"description":"The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_page_visibility":{"description":"The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_application_auth_strategy_id":{"description":"The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication.","type":"string","format":"uuid","nullable":true},"auto_approve_developers":{"description":"Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"auto_approve_applications":{"description":"Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"default_domain":{"description":"The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.","type":"string","format":"hostname","readOnly":true},"canonical_domain":{"description":"The canonical domain of the developer portal","type":"string","format":"hostname","nullable":false,"readOnly":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"}},"additionalProperties":false,"required":["name"],"title":"Portal"},"examples":{"Example 1":{"$ref":"#/components/examples/CreatePortalExample1"},"Authentication Disabled":{"$ref":"#/components/examples/CreatePortalExampleAuthenticationDisabled"},"Enable RBAC":{"$ref":"#/components/examples/CreatePortalExampleRbacEnabled"},"Auto Approve Settings":{"$ref":"#/components/examples/CreatePortalExampleAutoApprove"}}}}},"UpdatePortal":{"description":"Update a portal's settings.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the portal, used to distinguish it from other portals. Name must be unique.","type":"string","maxLength":255,"minLength":1},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","maxLength":255,"minLength":1,"nullable":false},"description":{"description":"A description of the portal.","type":"string","maxLength":512,"nullable":true},"authentication_enabled":{"description":"Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.","type":"boolean","default":true},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.","type":"boolean","default":false},"sipr_enabled":{"description":"Whether ip allow list is enabled for the portal.","type":"boolean","example":true,"default":false},"default_api_visibility":{"description":"The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_page_visibility":{"description":"The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_application_auth_strategy_id":{"description":"The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication.","type":"string","format":"uuid","nullable":true},"auto_approve_developers":{"description":"Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"auto_approve_applications":{"description":"Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"default_domain":{"description":"The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.","type":"string","format":"hostname","readOnly":true},"canonical_domain":{"description":"The canonical domain of the developer portal","type":"string","format":"hostname","nullable":false,"readOnly":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"}},"additionalProperties":false,"title":"Portal"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalExample1"},"Authentication Disabled":{"$ref":"#/components/examples/UpdatePortalExampleAuthenticationDisabled"},"Enable RBAC":{"$ref":"#/components/examples/UpdatePortalExampleRbacEnabled"},"Auto Approve Settings":{"$ref":"#/components/examples/UpdatePortalExampleAutoApprove"}}}}},"UpdateDeveloper":{"description":"Update a developer.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeveloperRequest"},"examples":{"Approved":{"$ref":"#/components/examples/UpdateDeveloperExampleApproved"},"Pending":{"$ref":"#/components/examples/UpdateDeveloperExamplePending"},"Rejected":{"$ref":"#/components/examples/UpdateDeveloperExampleRejected"},"Revoked":{"$ref":"#/components/examples/UpdateDeveloperExampleRevoked"}}}}},"ReplacePortalImageAsset":{"description":"Update an image asset for the portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacePortalImageAsset"},"examples":{"Example 1":{"$ref":"#/components/examples/ReplacePortalImageAssetExample1"}}}}},"ReplacePortalCustomization":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}},"ReplacePortalIntegrations":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIntegrations"}}}},"UpdatePortalIntegrations":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalIntegrations"}}}},"CreatePortalPage":{"description":"Create a page in a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalPageRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreatePortalPageExample1"}}}}},"UpdatePortalPage":{"description":"Update a page in a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalPageRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalPageExample1"}}}}},"MovePage":{"description":"move page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovePageRequestPayload"}}}},"CreatePortalSnippet":{"description":"Create a snippet in a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalSnippetRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreatePortalSnippetExample1"}}}}},"UpdatePortalSnippet":{"description":"Update a snippet in a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalSnippetRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalSnippetExample1"}}}}},"UpdateApplicationRegistration":{"description":"Update an application registration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationRegistrationRequest"},"examples":{"Approved":{"$ref":"#/components/examples/UpdateApplicationRegistrationApproved"},"Pending":{"$ref":"#/components/examples/UpdateApplicationRegistrationPending"},"Rejected":{"$ref":"#/components/examples/UpdateApplicationRegistrationRejected"},"Revoked":{"$ref":"#/components/examples/UpdateApplicationRegistrationRevoked"}}}}},"UpdateApplication":{"description":"Update an application.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationRequest"}}}},"ReplacePortalAuditLogReplayJob":{"description":"The request schema to replace a portal audit log replay job.","content":{"application/json":{"schema":{"type":"object","properties":{"start_at":{"description":"The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.\nMust be within the last 7 days.","type":"string","format":"date-time"},"end_at":{"description":"The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.\nMust be within the last 7 days.","type":"string","format":"date-time"}},"required":["start_at","end_at"]}}}},"UpdatePortalAuditLogWebhook":{"description":"The request schema to modify an portal audit log webhook.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"description":"Indicates if the data should be sent to the configured destination.","type":"boolean","example":true,"default":false},"audit_log_destination_id":{"description":"ID of the audit log destination.","type":"string","format":"uuid"}}},"examples":{"Disable Webhook":{"$ref":"#/components/examples/Disable-Portal-Audit-Log-Webhook"},"Enable Webhook":{"$ref":"#/components/examples/Enable-Portal-Audit-Log-Webhook"},"Update Webhook":{"$ref":"#/components/examples/Update-Portal-Audit-Log-Webhook"}}}}},"PortalUpdateTeam":{"description":"Update a team in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalUpdateTeamRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdateTeamExample1"}}}}},"PortalCreateTeam":{"description":"Create a team in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCreateTeamRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreateTeamExample1"}}}}},"UpdatePortalTeamGroupMappings":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalTeamGroupMappingsUpdateRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalTeamGroupMappingsExample1"}}}}},"UpdatePortalAuthenticationSettings":{"description":"Update a portal's developer authentication settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAuthenticationSettingsUpdateRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalAuthenticationSettingsExample1"},"Disable Basic Developer Auth":{"$ref":"#/components/examples/UpdatePortalAuthenticationSettingsExampleDisableBasicAuth"},"Enable OIDC Developer Auth":{"$ref":"#/components/examples/UpdatePortalAuthenticationSettingsExampleEnableOIDC"},"Enable OIDC Team Mapping":{"$ref":"#/components/examples/UpdatePortalAuthenticationSettingsExampleEnableOIDCTeamMapping"}}}}},"PortalAssignRole":{"description":"Assign a role to a team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAssignRoleRequest"},"examples":{"API Viewer":{"$ref":"#/components/examples/PortalAssignRoleExampleViewer"},"API Consumer":{"$ref":"#/components/examples/PortalAssignRoleExampleConsumer"}}}}},"AddDeveloperToTeam":{"description":"Add a developer to a team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDeveloperToTeamRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/AddDeveloperToTeamExample1"}}}}},"PatchCustomPortalEmailTemplatePayload":{"description":"Update a custom portal email template.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/EmailTemplateContent"},"enabled":{"description":"Whether the email template is enabled or disabled for a portal","type":"boolean","default":true}}},"examples":{"Enable Custom Template":{"$ref":"#/components/examples/UpdateCustomPortalTemplateEnabled"},"Update Custom Template Content":{"$ref":"#/components/examples/UpdateCustomPortalTemplateContent"}}}}},"PatchPortalEmailConfigPayload":{"description":"Update a portal email configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPortalEmailConfig"},"examples":{"Patch Portal Email Config":{"$ref":"#/components/examples/PatchPortalEmailConfigExample"}}}}},"PostPortalEmailConfigPayload":{"description":"Create a portal email configuration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostPortalEmailConfig"},"examples":{"Create Portal Email Config":{"$ref":"#/components/examples/PostPortalEmailConfigExample"}}}}},"PostSendTestEmailPayload":{"description":"Send a test email using a custom email template.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/SendTestEmailTemplateContent"}},"required":["content"]},"examples":{"Send test email":{"$ref":"#/components/examples/SendTestEmailTemplateExample"}}}}},"CreatePortalSourceIPRestriction":{"content":{"application/json":{"schema":{"type":"object","properties":{"allowed_ips":{"$ref":"#/components/schemas/PortalAllowedIPs"}},"additionalProperties":false,"required":["allowed_ips"]},"examples":{"Example Request Body":{"value":{"allowed_ips":["192.168.1.1","192.168.1.0/22"]}}}}}},"UpdatePortalSourceIPRestriction":{"content":{"application/json":{"schema":{"type":"object","properties":{"allowed_ips":{"$ref":"#/components/schemas/PortalAllowedIPs"}},"additionalProperties":false,"minProperties":1},"examples":{"Example Request Body":{"value":{"allowed_ips":["192.168.1.1","192.168.1.0/22"]}}}}}},"CreateIdentityProviderRequest":{"description":"An object representing the configuration for creating a new identity provider. This configuration may pertain  to either an OIDC or a SAML identity provider.\n","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIdentityProvider"},"examples":{"OIDC Identity Provider Request":{"$ref":"#/components/examples/CreateOIDCIdentityProvider"},"SAML Identity Provider Request With MetadataURL":{"$ref":"#/components/examples/CreateSAMLIdentityProviderWithMetadataURL"},"SAML Identity Provider Request With Metadata":{"$ref":"#/components/examples/CreateSAMLIdentityProviderWithMetadata"}}}}},"UpdateIdentityProviderRequest":{"description":"An object representing the configuration for updating an identity provider. This configuration may pertain  to either an OIDC or a SAML identity provider.\n","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityProvider"},"examples":{"Update OIDC Identity Provider":{"$ref":"#/components/examples/UpdateOIDCIdentityProvider"},"Update SAML Identity Provider":{"$ref":"#/components/examples/UpdateSAMLIdentityProvider"}}}}}},"responses":{"PortalTeamGroupMappingCollection":{"description":"A paginated collection of mappings grouped by team ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalTeamGroupMappingResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalTeamGroupMappingCollectionExample1"}}}}},"PortalAuthenticationSettings":{"description":"Details about a portal's authentication settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAuthenticationSettingsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalAuthenticationSettingsExample1"}}}}},"PortalAssignedRole":{"description":"Details about the role assignment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAssignedRoleResponse"},"examples":{"US Example":{"$ref":"#/components/examples/PortalAssignedRoleUSExample"},"All Regions Example":{"$ref":"#/components/examples/PortalAssignedRoleAllRegionsExample"}}}}},"PortalTeam":{"description":"Details about a team of developers in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalTeamResponse"},"examples":{"PortalTeamExample1":{"$ref":"#/components/examples/PortalTeamExample1"}}}}},"AssignedPortalRoleCollection":{"description":"A paginated collection of assigned roles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedPortalRoleCollectionResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/AssignedPortalRoleCollectionExample1"}}}}},"GetDeveloper":{"description":"Details about a developer in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDeveloper"},"examples":{"Example 1":{"$ref":"#/components/examples/GetDeveloperExample1"}}}}},"UpdateDeveloper":{"description":"Details about the developer being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDeveloper"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdateDeveloperResponseExample1"}}}}},"ListDevelopers":{"description":"A paginated list of developers in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevelopersResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListDevelopersExample1"}}}}},"ListPortalTeams":{"description":"A paginated list of teams in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalTeamsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalTeamsExample1"}}}}},"ListRoles":{"description":"A set of roles available in portals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListRolesExample1"}}}}},"ListBasicDevelopers":{"description":"A paginated list of basic developer information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBasicDevelopersResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListBasicDevelopersExample1"}}}}},"PortalCustomDomain":{"description":"Portal custom domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomDomain"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalCustomDomainExample1"}}}}},"ListPortalsResponse":{"description":"A paginated list of portals in the current region of an organization.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"title":"Portal","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the portal, used to distinguish it from other portals. Name must be unique.","type":"string","maxLength":255,"minLength":1},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","maxLength":255,"minLength":1,"nullable":false},"description":{"description":"A description of the portal.","type":"string","maxLength":512,"nullable":true},"authentication_enabled":{"description":"Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.","type":"boolean","default":true},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.","type":"boolean","default":false},"sipr_enabled":{"description":"Whether ip allow list is enabled for the portal.","type":"boolean","example":true,"default":false},"default_api_visibility":{"description":"The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_page_visibility":{"description":"The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_application_auth_strategy_id":{"description":"The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication.","type":"string","format":"uuid","nullable":true},"auto_approve_developers":{"description":"Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"auto_approve_applications":{"description":"Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"default_domain":{"description":"The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.","type":"string","format":"hostname","readOnly":true},"canonical_domain":{"description":"The canonical domain of the developer portal","type":"string","format":"hostname","nullable":false,"readOnly":true},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["id","name","display_name","description","authentication_enabled","rbac_enabled","sipr_enabled","default_api_visibility","default_page_visibility","default_application_auth_strategy_id","auto_approve_applications","auto_approve_developers","default_domain","canonical_domain","created_at","updated_at"]}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"]},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalsExample1"}}}}},"PortalResponse":{"description":"Details about a portal.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The name of the portal, used to distinguish it from other portals. Name must be unique.","type":"string","maxLength":255,"minLength":1},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","maxLength":255,"minLength":1,"nullable":false},"description":{"description":"A description of the portal.","type":"string","maxLength":512,"nullable":true},"authentication_enabled":{"description":"Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.","type":"boolean","default":true},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.","type":"boolean","default":false},"sipr_enabled":{"description":"Whether ip allow list is enabled for the portal.","type":"boolean","example":true,"default":false},"default_api_visibility":{"description":"The default visibility of APIs in the portal. If set to `public`, newly published APIs are visible to unauthenticated developers. If set to `private`, newly published APIs are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_page_visibility":{"description":"The default visibility of pages in the portal. If set to `public`, newly created pages are visible to unauthenticated developers. If set to `private`, newly created pages are hidden from unauthenticated developers.","type":"string","enum":["public","private"]},"default_application_auth_strategy_id":{"description":"The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to `null`, API publications will not use an authentication strategy unless set during publication.","type":"string","format":"uuid","nullable":true},"auto_approve_developers":{"description":"Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"auto_approve_applications":{"description":"Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean","default":false},"default_domain":{"description":"The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.","type":"string","format":"hostname","readOnly":true},"canonical_domain":{"description":"The canonical domain of the developer portal","type":"string","format":"hostname","nullable":false,"readOnly":true},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["id","name","display_name","description","authentication_enabled","rbac_enabled","sipr_enabled","default_api_visibility","default_page_visibility","default_application_auth_strategy_id","auto_approve_applications","auto_approve_developers","default_domain","canonical_domain","updated_at","created_at"],"title":"Portal"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalExample1"}}}}},"PortalAssetResponse":{"description":"Image asset for the portal. Can be either png, jpeg or svg","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PortalImageDataUri"}},"additionalProperties":false,"required":["data"]}}}},"PortalAssetResponseRaw":{"description":"Logo of the portal. Can be either png, jpeg or svg","content":{"image/jpeg":{"schema":{"$ref":"#/components/schemas/PortalImageAssetBlob"}},"image/png":{"schema":{"$ref":"#/components/schemas/PortalImageAssetBlob"}},"image/svg+xml":{"schema":{"$ref":"#/components/schemas/PortalImageAssetBlob"}}}},"PortalCustomizationResponse":{"description":"The current customization options for a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}},"PortalIntegrationsResponse":{"description":"The current integration configurations for a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIntegrations"}}}},"DefaultContentResponse":{"description":"Summary of created default content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultContent"},"examples":{"Example 1":{"$ref":"#/components/examples/DefaultContentExample1"}}}}},"PortalPage":{"description":"Details about a page in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalPageResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalPageExample1"}}}}},"ListPortalPages":{"description":"Tree of custom pages in a portal (nested `children`). Not paginated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalPagesResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalPagesExample1"}}}}},"PortalSnippet":{"description":"Details about a snippet in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSnippetResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalSnippetExample1"}}}}},"ListPortalSnippets":{"description":"A paginated list of custom snippets in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalSnippetsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalSnippetsExample1"}}}}},"ListApplications":{"description":"A paginated list of applications in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListApplicationsExample1"}}}}},"GetApplication":{"description":"Details about an application in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"},"examples":{"Key Auth Application":{"$ref":"#/components/examples/GetApplicationExampleBasic"},"Client Credentials Application with DCR":{"$ref":"#/components/examples/GetApplicationExampleDcr"},"Client Credentials Application without DCR":{"$ref":"#/components/examples/GetApplicationExampleOIDC"}}}}},"ListApplicationCredentials":{"description":"A paginated list of credentials for an application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCredentialsResponse"},"examples":{"ListApiKeyCredentials":{"$ref":"#/components/examples/ListApiKeyCredentialsExample"},"ListClientSecretCredentials":{"$ref":"#/components/examples/ListClientSecretCredentialsExample"}}}}},"ListApplicationDevelopers":{"description":"A paginated list developers of an application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationDevelopersResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListApplicationDevelopersExample1"}}}}},"ListApplicationRegistrations":{"description":"A paginated list of application registrations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationRegistrationsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListApplicationRegistrationsExample1"}}}}},"GetApplicationRegistration":{"description":"Details about an application registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationRegistrationResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetApplicationRegistrationExample1"}}}}},"UpdateApplicationRegistration":{"description":"Details about the application registration being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationRegistrationResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdateApplicationRegistrationResponseExample1"}}}}},"PortalAuditLogWebhook":{"description":"Portal audit log webhook response","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"description":"Indicates if the data should be sent to the configured audit log destination.","type":"boolean","example":true,"default":false},"audit_log_destination_id":{"description":"ID of the audit log destination.","type":"string","format":"uuid"}}},"examples":{"Get Portal Audit Log Webhook":{"$ref":"#/components/examples/Get-Portal-Audit-Log-Webhook"}}}}},"PortalAuditLogWebhookStatus":{"description":"Get response for portal audit log webhook status","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_status":{"description":"Current status of a webhook. `active` indicates the webhook is sending or ready to send requests.\n`inactive` indicates the webhook has been turned off due to failed attempts.","type":"string","example":"active","enum":["active","inactive"]},"webhook_enabled":{"description":"Configured status of a webhook. `enabled` indicates the client will accept requests.\n`disabled` indicates the client will not accept requests.","type":"boolean","example":true},"last_attempt_at":{"description":"The last time a request was made to the webhook, regardless of outcome.","type":"string","format":"date-time","example":"2023-03-21T09:29:14.52Z"},"last_response_code":{"description":"The last response code received from the webhook.","type":"integer","example":401},"last_response_message":{"description":"The last message received from the webhook. Useful for debugging.","type":"string","example":"Unauthenticated"}}},"examples":{"Get Audit Log Webhook Status":{"$ref":"#/components/examples/Get-Portal-Audit-Log-Webhook-Status"}}}}},"PortalAuditLogReplayJob":{"description":"Response from fetching or updating an portal audit log replay job","content":{"application/json":{"schema":{"type":"object","properties":{"start_at":{"description":"The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.","type":"string","format":"date-time","example":"2017-07-21T17:32:28Z"},"end_at":{"description":"The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.","type":"string","format":"date-time","example":"2017-07-21T17:32:28Z"},"status":{"type":"string","enum":["unconfigured","accepted","pending","running","completed","failed"],"readOnly":true},"updated_at":{"description":"Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.","type":"string","format":"date-time","readOnly":true}}}}}},"PortalReplayJobBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"PortalWebhookBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format is Invalid":{"$ref":"#/components/examples/400-request-format-is-invalid"},"Authorization Cannot be Blank":{"$ref":"#/components/examples/400-authorization-cannot-be-blank"},"Endpoint Cannot be Blank":{"$ref":"#/components/examples/400-endpoint-cannot-be-blank"},"Endpoint Must be a valid URL":{"$ref":"#/components/examples/400-endpoint-must-be-valid-url"}}}}},"PortalReplayJobConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Job Running":{"$ref":"#/components/examples/409-job-running"}}}}},"EmailTemplate":{"description":"Successful Retrieval for a portal email template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"},"examples":{"Example 1":{"$ref":"#/components/examples/EmailTemplateExample1"}}}}},"EmailTemplateVariables":{"description":"Successful response of usable variables for use in portal email templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateVariablesList"},"examples":{"Example 1":{"$ref":"#/components/examples/EmailTemplateVariable1"}}}}},"ListDefaultEmailTemplates":{"description":"A list of the default email templates in a portal. This is a static list that will always be populated.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DefaultEmailTemplate"}}},"additionalProperties":false},"examples":{"Example 1":{"$ref":"#/components/examples/ListDefaultEmailTemplatesExample1"}}}}},"ListEmailTemplates":{"description":"A list of customized email templates used in a portal.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplate"}}},"additionalProperties":false},"examples":{"Example 1":{"$ref":"#/components/examples/ListEmailTemplateExample1"}}}}},"DefaultEmailTemplate":{"description":"Details about a default email template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultEmailTemplate"},"examples":{"Example 1":{"$ref":"#/components/examples/GetDefaultEmailTemplateExample1"}}}}},"PatchEmailTemplateResponse":{"description":"Modifying an email template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"},"examples":{"Example 1":{"$ref":"#/components/examples/PatchEmailTemplateResponseExample1"}}}}},"PortalEmailConfigResponse":{"description":"Portal email config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEmailConfig"},"examples":{"Example Portal Email Config Response":{"$ref":"#/components/examples/PortalEmailConfigExample"}}}}},"PortalSourceIPRestrictionPaginatedResponse":{"description":"The portal's IP allow list configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMetaPage"},"data":{"$ref":"#/components/schemas/IPEntries"}},"additionalProperties":false,"required":["data","meta"]},"examples":{"Example":{"value":{"meta":{"next":"/portals/{id}/ip-allow-list?page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ","previous":"/portals/{id}/ip-allow-list?page[before]=efogICJpZCI6ICJoZWysbyB3b3JsZCIKgR","size":2},"data":[{"id":"660e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.1"]},{"id":"770e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.0/22"]}]}}}}}},"PortalSourceIPRestriction":{"description":"The portal's IP allow list configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPEntry"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"IdentityProviders":{"description":"A collection of identity providers. This response contains a collection of identity providers, which may  include both OIDC and SAML identity providers.\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProvider"},"title":"Identity Provider Collection Response"},"examples":{"Identity Provider Collection":{"$ref":"#/components/examples/IdentityProviders"}}}}},"IdentityProvider":{"description":"An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvider"},"examples":{"OIDC Identity Provider":{"$ref":"#/components/examples/OIDCIdentityProvider"},"SAML Identity Provider With Meta Data URL":{"$ref":"#/components/examples/SAMLIdentityProvider"},"SAML Identity Provider With Meta Data":{"$ref":"#/components/examples/SAMLIdentityProviderWithMetadata"}}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Portals","description":"APIs related to configuration of Konnect Developer Portals."},{"name":"Portal Custom Domains","description":"APIs related to configuration of Konnect Developer Portals custom domains."},{"name":"Portal Customization","description":"APIs related to customization of Konnect Developer Portals."},{"name":"Portal Auth Settings","description":"APIs related to configuration of Konnect Developer Portal auth settings."},{"name":"Portal Developers","description":"APIs related to Konnect Developer Portal developers."},{"name":"Portal Teams","description":"APIs related to configuration of Konnect Developer Portal developer teams."},{"name":"Portal Team Membership","description":"APIs related to Konnect Developer Portal developer team membership."},{"name":"Portal Team Roles","description":"APIs related to Konnect Developer Portal developer team roles."},{"name":"Portal Integrations","description":"APIs to configure Konnect Developer Portal integrations."},{"name":"Assets","description":"APIs for managing static assets for Konnect Developer Portals."},{"name":"Pages","description":"APIs related to Konnect Developer Portal Custom Pages."},{"name":"Snippets","description":"APIs related to Konnect Developer Portal Custom Snippets."},{"name":"Applications","description":"APIs related to Konnect Developer Portal Applications."},{"name":"Application Registrations","description":"APIs related to Konnect Developer Portal Application Registrations."},{"name":"Portal Emails","description":"APIs related to Konnect Developer Portal Emails."},{"name":"Portals IP Allow List","description":"APIs related to Konnect Portal IP Allow List."}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
