---
title: "Portal Management V3"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-dev-3/versions/e0dbc95a-4b74-44e7-ac0a-71aa3ce313a6"
---

# 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":{"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}/custom-domain":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"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"]}},"/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}/applications":{"post":{"operationId":"create-application","summary":"Create Application","description":"Creates a new application for this portal. The application must be assigned to a developer or a team. An 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"}],"requestBody":{"$ref":"#/components/requestBodies/CreateApplication"},"responses":{"201":{"$ref":"#/components/responses/GetApplication"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"CreateApplicationBadRequestExample1":{"$ref":"#/components/examples/CreateApplicationBadRequestExample1"},"CreateApplicationBadRequestExample2":{"$ref":"#/components/examples/CreateApplicationBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Applications"]}},"/portals/{portalId}/applications/{applicationId}/developers/{developerId}":{"put":{"operationId":"add-developer-to-application","summary":"Add Developer to Application","description":"Add a developer as an owner of the application.","responses":{"200":{"$ref":"#/components/responses/ApplicationDeveloper"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"AddDeveloperToApplicationBadRequestExample1":{"$ref":"#/components/examples/AddDeveloperToApplicationBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Applications"]},"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/DeveloperId"}],"delete":{"operationId":"remove-developer-from-application","summary":"Remove Developer from Application","description":"Remove a developer from an application. There must be at least one remaining owner.","responses":{"204":{"description":"No Content"},"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"},"examples":{"RemoveDeveloperFromApplicationConflictExample1":{"$ref":"#/components/examples/RemoveDeveloperFromApplicationConflictExample1"}}}}}},"tags":["Applications"]}},"/portals/{portalId}/applications/{applicationId}/registrations":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"post":{"operationId":"create-application-registration","summary":"Create Registration","description":"Creates a new registration for this application to access a specific API. Registrations created through the portal management API will respect the auto-approve settings of the portal and/or API publication. API publications that do not use auto-approve must be manually approved by an administrator after creation.","requestBody":{"$ref":"#/components/requestBodies/CreateApplicationRegistration"},"responses":{"201":{"$ref":"#/components/responses/GetApplicationRegistration"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"CreateApplicationRegistrationBadRequestExample1":{"$ref":"#/components/examples/CreateApplicationRegistrationBadRequestExample1"},"CreateApplicationRegistrationBadRequestExample2":{"$ref":"#/components/examples/CreateApplicationRegistrationBadRequestExample2"}}}}},"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"},"examples":{"CreateApplicationRegistrationConflictExample":{"$ref":"#/components/examples/CreateApplicationRegistrationConflictExample"}}}}}},"tags":["Application Registrations"]}},"/portals/{portalId}/developers":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"post":{"operationId":"create-developer","summary":"Create Developer Account","description":"Creates a new developer account in the specified portal.","requestBody":{"$ref":"#/components/requestBodies/CreateDeveloper"},"responses":{"201":{"$ref":"#/components/responses/CreateDeveloperResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"CreateDeveloperBadRequestExample1":{"$ref":"#/components/examples/CreateDeveloperBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"CreateDeveloperConflictExample1":{"$ref":"#/components/examples/CreateDeveloperConflictExample1"}}}}}},"tags":["Portal Developers"]}},"/portals/{portalId}/identity-providers/{id}/team-group-mappings":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/IdentityProviderId"}],"get":{"operationId":"list-portal-idp-team-group-mappings","summary":"List Team Group Mappings","description":"Returns a paginated list of team group mappings for the specified identity provider.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"},{"name":"filter","in":"query","description":"Filter mappings by team ID or group name.","required":false,"schema":{"type":"object","properties":{"team_id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"group":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/PortalIdpTeamGroupMappingCollection"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Auth Settings"]},"post":{"operationId":"create-portal-idp-team-group-mapping","summary":"Create Team Group Mapping","description":"Creates a new team group mapping for the specified identity provider.\n","requestBody":{"$ref":"#/components/requestBodies/CreatePortalIdpTeamGroupMapping"},"responses":{"201":{"$ref":"#/components/responses/PortalIdpTeamGroupMapping"},"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"]}},"/portals/{portalId}/identity-providers/{id}/team-group-mappings/{mappingId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/IdentityProviderId"},{"$ref":"#/components/parameters/TeamGroupMappingId"}],"get":{"operationId":"get-portal-idp-team-group-mapping","summary":"Get Team Group Mapping","description":"Returns the team group mapping for the specified ID.","responses":{"200":{"$ref":"#/components/responses/PortalIdpTeamGroupMapping"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Auth Settings"]},"delete":{"operationId":"delete-portal-idp-team-group-mapping","summary":"Delete Team Group Mapping","description":"Deletes a team group mapping by ID.\nReturns 204 if the mapping was deleted, or 404 if the mapping was not found.\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-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"]}},"/portals/{portalId}/mcp-registry-publications":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-mcp-registry-publications","summary":"List portal MCP registry publications","description":"Returns a list of MCP registry publications for a specific portal","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter publications returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/PortalMcpRegistryPublicationFilterParameters"},"style":"deepObject"},{"$ref":"#/components/parameters/SortPortalMcpRegistryPublications"}],"responses":{"200":{"description":"A paginated list of portal MCP registry publications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalMcpRegistryPublicationList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Portal MCP Registry Publications"]}}},"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."},"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"}},"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."},"SortPortalMcpRegistryPublications":{"name":"sort","description":"Sorts a collection of MCP registry publications. Supported sort attributes are:\n  - mcp_registry_id\n","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},"TeamGroupMappingId":{"name":"mappingId","in":"path","required":true,"description":"ID of the team group mapping.","schema":{"type":"string","format":"uuid"}}},"schemas":{"CreatePortalIdpTeamGroupMappingRequest":{"type":"object","properties":{"team_id":{"description":"The Konnect team ID.","type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"},"group":{"description":"The IdP group name.","type":"string","example":"API Engineers"}},"required":["team_id","group"]},"PortalIdpTeamGroupMapping":{"type":"object","properties":{"id":{"description":"The mapping ID.","type":"string","format":"uuid","example":"a1b2c3d4-e5f6-4a8b-9c0d-1e2f3a4b5c6d","readOnly":true},"team_id":{"description":"The Konnect team ID.","type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"},"group":{"description":"The IdP group name.","type":"string","example":"API Engineers"},"created_at":{"description":"Creation timestamp.","type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","readOnly":true},"updated_at":{"description":"Last update timestamp.","type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","readOnly":true}},"required":["id","team_id","group","created_at","updated_at"]},"PortalIdpTeamGroupMappingCollectionResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalIdpTeamGroupMapping"}}},"required":["meta","data"]},"CreateDeveloperRequest":{"description":"Request body for creating a developer in a portal.","type":"object","properties":{"email":{"type":"string","format":"email","maxLength":255},"full_name":{"type":"string","maxLength":255},"status":{"description":"When omitted, the portal's `auto_approve_developers` setting determines the initial status. Set this property to override the portal default with any valid developer status.","type":"string","example":"approved","enum":["approved","pending","revoked","rejected"],"title":"DeveloperStatus"},"send_invitation_email":{"description":"When true, sends an invitation email to the developer. Default is false; no emails are sent unless explicitly requested.","type":"boolean","default":false}},"example":{"email":"developer@example.com","full_name":"Developer Name"},"additionalProperties":false,"required":["email","full_name"],"title":"CreateDeveloperRequest"},"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"},"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"},"CreateApplicationRequest":{"type":"object","properties":{"name":{"description":"The name of the application.","type":"string","maxLength":255},"description":{"description":"A description of the application.","type":"string","maxLength":255},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"dcr_client_id":{"description":"If using a DCR auth strategy, set this property to link the portal application to an existing\nclient from the DCR provider, instead of having Konnect create a new client.\nThis allows importing existing clients from an Identity Provider into Konnect, allowing\nthem to be controlled through the DCR flows in the portal, and use existing client secrets\nfor API access.\nThe value must be a valid client ID in the DCR provider associated with the auth strategy.\nIf it is not valid, application will be created but will not function properly.\n","type":"string","maxLength":255},"client_id":{"$ref":"#/components/schemas/ApplicationClientId"},"auth_strategy_id":{"description":"The ID of the authentication strategy the application will use when making requests to registered APIs.","type":"string","format":"uuid"},"owner":{"$ref":"#/components/schemas/ApplicationOwner"}},"example":{"name":"Portal Application","description":"A portal application provisioned for a developer by a Portal Admin.","labels":{"env":"production"},"auth_strategy_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","owner":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","type":"developer"}},"additionalProperties":false,"required":["name","owner"],"title":"CreateApplicationRequest"},"GetApplicationResponse":{"$ref":"#/components/schemas/Application"},"GetApplicationRegistrationResponse":{"$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"},"CreateApplicationRegistrationRequest":{"type":"object","properties":{"api_id":{"description":"The ID of the API the application is registering for.","type":"string","format":"uuid"},"status":{"description":"The status of the application registration. It must be a valid status value for a registration creation.","type":"string","example":"approved","enum":["approved","pending"]}},"example":{"api_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"additionalProperties":false,"required":["api_id"],"title":"CreateApplicationRegistrationRequest"},"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"},"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"},"UpdatePortalCustomDomainSSL":{"type":"object","properties":{"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,"title":"UpdatePortalCustomDomainSSL"},"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"},"UpdatePortalCustomDomainRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"ssl":{"$ref":"#/components/schemas/UpdatePortalCustomDomainSSL"}},"additionalProperties":false,"title":"UpdatePortalCustomDomainRequest"},"PortalMcpRegistryPublicationFilterParameters":{"type":"object","properties":{"visibility":{"description":"Filter by visibility","type":"string","enum":["public","private"]},"mcp_registry_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false},"PortalMcpRegistryPublication":{"description":"Represents a publication of an MCP registry to a portal","type":"object","properties":{"mcp_registry_id":{"description":"The ID of the MCP registry","type":"string","format":"uuid","example":"5f2e3b1a-9c4d-4e8f-a7b6-1d2e3f4a5b6c"},"portal_id":{"description":"The ID of the portal the registry is published to","type":"string","format":"uuid","example":"7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"},"visibility":{"description":"Visibility of the MCP registry on the portal","type":"string","example":"public","enum":["public","private"]},"created_at":{"description":"Timestamp when the publication was created","type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"updated_at":{"description":"Timestamp when the publication was last updated","type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"}},"additionalProperties":false,"required":["mcp_registry_id","portal_id","visibility","created_at","updated_at"]},"PortalMcpRegistryPublicationList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalMcpRegistryPublication"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"]},"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"}}},"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"}}}]},"PortalMenuItem":{"type":"object","properties":{"path":{"description":"The absolute path of a page in a portal with a leading slash.","type":"string","example":"/about/company","maxLength":512},"title":{"description":"The link display text","type":"string","example":"My Page"},"visibility":{"description":"Whether a menu item is public or private. Private menu items are only accessible to authenticated users.","type":"string","example":"public","enum":["public","private"]},"external":{"description":"When clicked, open the link in a new window","type":"boolean"}},"additionalProperties":false,"required":["path","title","visibility","external"]},"PortalFooterMenuSection":{"type":"object","properties":{"title":{"description":"The footer menu section title","type":"string","maxLength":512},"items":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}},"additionalProperties":false,"required":["title","items"]},"PortalCustomization":{"description":"The custom settings of this portal","type":"object","properties":{"theme":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":false},"mode":{"type":"string","enum":["light","dark","system"]},"colors":{"type":"object","additionalProperties":false,"properties":{"primary":{"type":"string","example":"#000000","nullable":false,"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","x-validation-message":"must be a valid hex color value"}}}}},"layout":{"type":"string","nullable":false},"css":{"type":"string","nullable":true},"js":{"type":"object","additionalProperties":false,"properties":{"custom":{"type":"string","nullable":true},"scripts":{"type":"array","items":{"type":"string","pattern":"^https://[^:.]+\\..+$"},"maxItems":20}}},"menu":{"type":"object","additionalProperties":false,"properties":{"main":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}},"footer_sections":{"type":"array","items":{"$ref":"#/components/schemas/PortalFooterMenuSection"}},"footer_bottom":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}}},"spec_renderer":{"type":"object","additionalProperties":false,"properties":{"try_it_ui":{"description":"Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.","type":"boolean","default":true},"try_it_insomnia":{"description":"Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.","type":"boolean","default":true},"infinite_scroll":{"description":"Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.","type":"boolean","default":true},"show_schemas":{"description":"Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.","type":"boolean","default":true},"hide_internal":{"description":"Manage visibility of internal endpoints and models.","type":"boolean","default":false},"hide_deprecated":{"description":"Manage visibility of deprecated endpoints and models.","type":"boolean","default":false},"allow_custom_server_urls":{"description":"Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.","type":"boolean","default":true}}},"robots":{"type":"string","nullable":true}},"additionalProperties":false,"title":"PortalCustomization"},"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"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"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","consent_required","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"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"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","consent_required","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"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"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"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"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"]},"ApplicationClientId":{"description":"An identifier to correlate the application with an external system.\nCannot be set when using Dynamic Client Registration.\n","type":"string","maxLength":255},"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"},"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"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]},"SortQuery":{"description":"The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n","type":"string","example":"created_at desc","title":"SortQuery"}},"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"}]}},"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"}},"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"}},"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}},"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"}]}},"CreateDeveloperExample1":{"value":{"email":"developer@example.com","full_name":"Developer Name"}},"CreateDeveloperExample2":{"summary":"With optional status and invitation email","value":{"email":"invited-dev@example.com","full_name":"Invited Developer","status":"pending","send_invitation_email":true}},"CreateApplicationExample":{"value":{"name":"Portal Application","description":"A portal application provisioned for a developer by a Portal Admin.","labels":{"env":"test"},"auth_strategy_id":"85606071-49c7-4c2e-ae49-8a86d72a8110","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}},"CreateOIDCApplicationExample":{"value":{"name":"My OIDC Application","description":"This application has been pre-configured in an identity provider and is linked by its client_id.","labels":{"env":"test"},"auth_strategy_id":"75606071-49c7-4c2e-ae49-8a86d72a8110","client_id":"z5Ul9d8f0h3kL0j2p4q0","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}},"CreateApplicationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"auth_strategy_id","rule":"is_uuid","reason":"\"auth_strategy_id\" must be a valid UUID","source":"body"}]}},"CreateApplicationBadRequestExample2":{"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"}]}},"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"}}},"ApplicationDeveloperExample1":{"value":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","email":"jim.developer@example.com","full_name":"Jim Dev"}},"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"}},"CreateApplicationRegistrationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"api_id","rule":"is_uuid","reason":"\"api_id\" must be a valid UUID","source":"body"}]}},"CreateApplicationRegistrationBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"api_id","rule":"required","reason":"\"api_id\" is required","source":"body"}]}},"CreateApplicationRegistrationConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:1433447772874964729","detail":"API is already registered to the application"}},"AddDeveloperToApplicationBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"developer_id","rule":"unknown_property","reason":"\"developer_id\" is not allowed","source":"body"}]}},"RemoveDeveloperFromApplicationConflictExample1":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:1433447772874964729","detail":"At least one developer must be associated with the application"}},"CreateApplicationRegistrationExample1":{"value":{"api_id":"56f637b7-cd95-478b-9b02-d770618f641c"}},"CreateDeveloperBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"email","rule":"required","reason":"\"email\" is required","source":"body"}]}},"CreateDeveloperConflictExample1":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:1433447772874964729","detail":"Developer with the given email already exists"}},"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"}}},"requestBodies":{"CreatePortalIdpTeamGroupMapping":{"description":"Create a team group mapping for an identity provider.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalIdpTeamGroupMappingRequest"}}}},"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"},"create_default_content":{"description":"Use to create the portal page default content upon creation of this portal","type":"boolean","default":false}},"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"}}}}},"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"}}}},"CreateDeveloper":{"description":"Create a developer for a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeveloperRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreateDeveloperExample1"},"Example 2":{"$ref":"#/components/examples/CreateDeveloperExample2"}}}}},"CreateApplication":{"description":"Create an application for a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplicationRequest"},"examples":{"Create Application Example":{"$ref":"#/components/examples/CreateApplicationExample"},"Create OIDC Application Example":{"$ref":"#/components/examples/CreateOIDCApplicationExample"}}}}},"CreateApplicationRegistration":{"description":"Create an application registration for a portal application.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplicationRegistrationRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreateApplicationRegistrationExample1"}}}}},"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"},"include_principal_name":{"description":"Whether to include the principal name in the audit log entries sent to the webhook.","type":"boolean","example":true,"default":false}}},"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"}}}}}},"responses":{"PortalIdpTeamGroupMapping":{"description":"A team group mapping for an identity provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIdpTeamGroupMapping"}}}},"PortalIdpTeamGroupMappingCollection":{"description":"A paginated collection of team group mappings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIdpTeamGroupMappingCollectionResponse"}}}},"CreateDeveloperResponse":{"description":"Details about the created developer in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDeveloper"},"examples":{"Example 1":{"$ref":"#/components/examples/GetDeveloperExample1"}}}}},"PortalCustomDomain":{"description":"Portal custom domain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomDomain"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalCustomDomainExample1"}}}}},"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"}}}}},"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"}}}},"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"}}}}},"ApplicationDeveloper":{"description":"Details about a developer of an application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeveloperDetailed"},"examples":{"Example 1":{"$ref":"#/components/examples/ApplicationDeveloperExample1"}}}}},"GetApplicationRegistration":{"description":"Details about an application registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationRegistrationResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetApplicationRegistrationExample1"}}}}},"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"},"include_principal_name":{"description":"Whether to include the principal name in the audit log entries sent to the webhook.","type":"boolean","example":true,"default":false}}},"examples":{"Get Portal Audit Log Webhook":{"$ref":"#/components/examples/Get-Portal-Audit-Log-Webhook"}}}}},"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"}}}}},"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"}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"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 Integrations","description":"APIs to configure Konnect Developer Portal integrations."},{"name":"Applications","description":"APIs related to Konnect Developer Portal Applications."},{"name":"Application Registrations","description":"APIs related to Konnect Developer Portal Application Registrations."},{"name":"Portal MCP Registry Publications","description":"APIs related to MCP registry publications on Konnect Developer Portals."}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
