---
title: "Portal Management"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37"
---

# Portal Management

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Portal Management","version":"2.2.2","description":"The management API for Portals","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","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 appearance, configuration, 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":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"description":{"$ref":"#/components/schemas/StringFieldFilter"},"is_public":{"$ref":"#/components/schemas/BooleanFieldFilter"},"rbac_enabled":{"$ref":"#/components/schemas/BooleanFieldFilter"},"auto_approve_developers":{"$ref":"#/components/schemas/BooleanFieldFilter"},"auto_approve_applications":{"$ref":"#/components/schemas/BooleanFieldFilter"},"default_domain":{"$ref":"#/components/schemas/StringFieldFilter"},"custom_domain":{"$ref":"#/components/schemas/StringFieldFilter"},"custom_client_domain":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListPortals"},"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/CreatePortal"},"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"},"UpdatePortalBadRequestExample6":{"$ref":"#/components/examples/UpdatePortalBadRequestExample6"},"UpdatePortalBadRequestExample7":{"$ref":"#/components/examples/UpdatePortalBadRequestExample7"}}}}},"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 Portal","description":"Returns the configuration for a single developer portal. This allows you to understand the current visibility, access, and domain settings.","responses":{"200":{"$ref":"#/components/responses/GetPortal"},"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/UpdatePortal"},"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"},"UpdatePortalBadRequestExample6":{"$ref":"#/components/examples/UpdatePortalBadRequestExample6"},"UpdatePortalBadRequestExample7":{"$ref":"#/components/examples/UpdatePortalBadRequestExample7"}}}}},"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. Will not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled, unless force=true query param is included in the request.","parameters":[{"name":"force","in":"query","description":"If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled.","schema":{"type":"string","default":"false","enum":["true","false"]}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"DeletePortalBadRequestExample1":{"$ref":"#/components/examples/DeletePortalBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals"]}},"/portals/{portalId}/publish":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"post":{"operationId":"publish-api-products","summary":"Publish Multiples Products","description":"Publish or Unpublish multiple API Products to this developer portal.","requestBody":{"$ref":"#/components/requestBodies/PublishAPIProducts"},"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":["API Products"]}},"/portals/{portalId}/products":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-products","summary":"List Portal Products","description":"Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer teams.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortPortalProducts"},{"$ref":"#/components/parameters/PortalProductFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalProducts"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ListPortalProductsBadRequestExample1":{"$ref":"#/components/examples/ListPortalProductsBadRequestExample1"},"ListPortalProductsBadRequestExample2":{"$ref":"#/components/examples/ListPortalProductsBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Products"]}},"/portals/{portalId}/product-versions":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"list-portal-product-versions","summary":"List portal product versions","description":"List portal product versions","parameters":[{"$ref":"#/components/parameters/SortPortalProductVersions"},{"$ref":"#/components/parameters/PortalProductVersionFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListPortalProductVersions"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]},"post":{"operationId":"create-portal-product-version","summary":"Create a portal product version","description":"Create a portal product version","requestBody":{"$ref":"#/components/requestBodies/CreatePortalProductVersion"},"responses":{"201":{"$ref":"#/components/responses/PortalProductVersion"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]}},"/portals/{portalId}/product-versions/{productVersionId}":{"parameters":[{"$ref":"#/components/parameters/ProductVersionId"},{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-product-version","summary":"Get a portal product version","description":"Get a portal product version","responses":{"200":{"$ref":"#/components/responses/PortalProductVersion"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]},"patch":{"operationId":"update-portal-product-version","summary":"Update a portal product version","description":"Update a portal product version","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalProductVersion"},"responses":{"200":{"$ref":"#/components/responses/PortalProductVersion"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]},"put":{"operationId":"replace-portal-product-version","summary":"Replace a portal product version","description":"Replace a portal product version","requestBody":{"$ref":"#/components/requestBodies/ReplacePortalProductVersion"},"responses":{"200":{"$ref":"#/components/responses/PortalProductVersion"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]},"delete":{"operationId":"delete-portal-product-version","summary":"Delete a portal product version","description":"Delete a portal product version","responses":{"204":{"description":"No Content."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Product Versions"]}},"/portals/{portalId}/developers/{developerId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/DeveloperId"}],"get":{"operationId":"get-developer","summary":"Get Developer","description":"Returns information about a single developer in this portal. Each developer manages a set applications, providing them credentials to access registered API product versions. Developer registration access can be limited to specific API products using RBAC.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/DeveloperId"}],"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 API Products. 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}/applications":{"get":{"operationId":"list-applications","summary":"List Applications","description":"Lists applications created by developers in this portal. Each application can be registered for various API Products (by version), issuing credentials for API request access. If using DCR, an application will be linked to an Identity Provider's application by its `reference_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":{"type":"object","properties":{"developer_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"developer_name":{"$ref":"#/components/schemas/StringFieldFilter"},"developer_email":{"$ref":"#/components/schemas/StringFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"}}},"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":["Portal Applications"]}},"/portals/{portalId}/applications/{applicationId}":{"get":{"operationId":"get-application","summary":"Get 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 `reference_id` can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"200":{"$ref":"#/components/responses/GetApplication"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Applications"]},"delete":{"operationId":"delete-application","summary":"Delete Application by Portal","description":"Delete a single application in this portal, along with its registrations and credentials.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"204":{"description":"The application has been deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Applications"]}},"/applications/{applicationId}":{"get":{"operationId":"get-application-unscoped","summary":"Get 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 `reference_id` can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"200":{"$ref":"#/components/responses/GetApplication"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Applications"]}},"/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/{portalId}/application-registrations":{"get":{"operationId":"list-registrations","summary":"List Application 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 product version. Access is provided through the credentials issued to the application that contains each registration.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$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"},"developer_name":{"$ref":"#/components/schemas/StringFieldFilter"},"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":["Portal Application Registrations"]}},"/portals/{portalId}/applications/{applicationId}/registrations":{"get":{"operationId":"list-registrations-by-application","summary":"List Registrations by Application","description":"Lists each API product version that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"},{"$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":["Portal 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 Application Registration","description":"Returns information about an application's registration status for a particular API product version.","responses":{"200":{"$ref":"#/components/responses/GetApplicationRegistration"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Application Registrations"]},"patch":{"operationId":"update-application-registration","summary":"Update Application Registration","description":"Updates the status of a particular application registration to an API Product Version. 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":["Portal Application Registrations"]},"delete":{"operationId":"delete-application-registration","summary":"Delete Application Registration","description":"Deletes an application registration, which if currently approved will immediately block API traffic to the API product version.\nNote: Developers can request a new application registration for the given API product version 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":["Portal Application Registrations"]}},"/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}/granted-scopes":{"get":{"operationId":"list-granted-scopes","summary":"List Granted Scopes","description":"Lists the granted scopes for this application registration. This is the list of scopes that will be sent to the API when making requests.","parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/RegistrationId"}],"responses":{"200":{"$ref":"#/components/responses/ListGrantedScopes"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Portal Application Registrations"]}},"/portals/appearance-defaults":{"get":{"operationId":"get-portal-appearance-defaults","summary":"Get Default Appearance Configurations","description":"Returns the built-in portal appearance configurations including pre-defined themes, colors, and font settings.","responses":{"200":{"$ref":"#/components/responses/GetAppearanceDefaults"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Appearance"]}},"/portals/{portalId}/appearance":{"get":{"operationId":"get-portal-appearance","summary":"Get Appearance Configuration","description":"Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalAppearance"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Appearance"]},"patch":{"operationId":"update-portal-appearance","summary":"Update Appearance Configuration","description":"Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdatePortalAppearance"},"responses":{"200":{"$ref":"#/components/responses/UpdatePortalAppearance"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateAppearanceConfigurationBadRequestExample1":{"$ref":"#/components/examples/UpdateAppearanceConfigurationBadRequestExample1"},"UpdateAppearanceConfigurationBadRequestExample2":{"$ref":"#/components/examples/UpdateAppearanceConfigurationBadRequestExample2"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Appearance"]}},"/portals/{portalId}/appearance/logo":{"get":{"operationId":"get-portal-logo","summary":"Get Portal Logo","description":"Returns the portal logo or returns the default","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalLogoResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Appearance"]}},"/portals/{portalId}/appearance/catalog-cover":{"get":{"operationId":"get-portal-catalog-cover","summary":"Get Portal Catalog Cover","description":"Returns the portal catalog cover or returns the default","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalCatalogCoverResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Appearance"]}},"/portals/{portalId}/verify-domain":{"post":{"operationId":"verify-portal-domains","summary":"Verify Custom Domains","description":"Verifies the current status of the custom hosted domain for this portal, indicating whether the appropriate CNAME properties have propagated and if a corresponding SSL certificate has been generated.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/VerifyPortalDomains"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"VerifyPortalDomainsBadRequestExample1":{"$ref":"#/components/examples/VerifyPortalDomainsBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portals"]}},"/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 (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier 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":"Lists 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":"Allows 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"}}},"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/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}/teams":{"parameters":[{"$ref":"#/components/parameters/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"}],"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"}},"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"}},"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"]}}},"components":{"parameters":{"ApplicationId":{"name":"applicationId","in":"path","required":true,"description":"The application ID","schema":{"$ref":"#/components/schemas/UUID"}},"DeveloperId":{"name":"developerId","in":"path","required":true,"description":"The developer ID","schema":{"$ref":"#/components/schemas/UUID"}},"IdentityProviderId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"id","in":"path","required":true,"description":"ID of the identity provider."},"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}},"parameters-DeveloperId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"developerId","in":"path","required":true,"description":"ID of the developer."},"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."},"PortalProductFilter":{"name":"filter","description":"Filters a collection of Portal Products.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/PortalProductFilters"}},"PortalProductVersionFilter":{"name":"filter","description":"Filters a collection of Portal Product Versions.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/PortalProductVersionFilters"}},"ProductVersionId":{"name":"productVersionId","description":"API product version identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"RegistrationId":{"name":"registrationId","in":"path","required":true,"description":"The application registration ID","schema":{"$ref":"#/components/schemas/UUID"}},"RoleId":{"schema":{"type":"string","format":"uuid","example":"8350205f-a305-4e39-abe9-bc082a80091a"},"name":"roleId","in":"path","required":true},"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"}},"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"}},"SortPortalProducts":{"name":"sort","description":"Sorts a collection of Portal Products. Supported sort attributes are:\n  - created_at\n  - name\n  - description\n","in":"query","required":false,"schema":{"type":"string"}},"SortPortalProductVersions":{"name":"sort","description":"Sorts a collection of Portal Product Versions. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - publish_status\n  - product_version_id\n  - auth_strategy_ids\n  - application_registration_enabled\n  - auto_approve_registration\n  - deprecated\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  - is_public\n  - rbac_enabled\n  - auto_approve_applications\n  - auto_approve_developers\n  - default_domain\n  - custom_domain\n  - custom_client_domain\n  - created_at\n  - updated_at\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":{"AuthStrategy":{"type":"object","discriminator":{"propertyName":"credential_type"},"oneOf":[{"$ref":"#/components/schemas/AuthStrategyKeyAuth"},{"$ref":"#/components/schemas/AuthStrategyClientCredentials"}]},"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"},"PortalOIDCConfig":{"description":"Configuration properties for an OpenID Connect Identity Provider.","type":"object","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"}},"example":{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}},"required":["issuer","client_id"],"title":"PortalOIDCConfig"},"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":{"description":"The portal has OIDC enabled or disabled.","type":"boolean","example":false},"saml_auth_enabled":{"description":"The portal has SAML enabled or disabled.","type":"boolean","example":false},"oidc_team_mapping_enabled":{"description":"IdP groups determine the Portal Teams a developer has.","type":"boolean","example":true},"idp_mapping_enabled":{"description":"IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled.","type":"boolean","example":true},"konnect_mapping_enabled":{"description":"A Konnect Identity Admin assigns teams to a developer.","type":"boolean","example":false},"oidc_config":{"$ref":"#/components/schemas/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"},{"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"},{"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"}]},"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":"The organization has OIDC disabled.","type":"boolean","example":false},"saml_auth_enabled":{"description":"The portal has SAML enabled or disabled.","type":"boolean","example":false},"oidc_team_mapping_enabled":{"description":"Whether IdP groups determine the Konnect Portal teams a developer has.","type":"boolean","example":true},"konnect_mapping_enabled":{"description":"Whether a Konnect Identity Admin assigns teams to a developer.","type":"boolean","example":false},"idp_mapping_enabled":{"description":"Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled.","type":"boolean","example":true},"oidc_issuer":{"type":"string"},"oidc_client_id":{"type":"string"},"oidc_client_secret":{"type":"string"},"oidc_scopes":{"type":"array","items":{"type":"string","default":"openid"},"default":["email","openid","profile"]},"oidc_claim_mappings":{"$ref":"#/components/schemas/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}},"example":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team."},"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}},"example":{"name":"IDM - Developers","description":"The Identity Management (IDM) team."},"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}},"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"},"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"},"ListPortalsResponse":{"description":"A paginated list of portals in the current region in the organization.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Portal"}}},"example":{"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","default_domain":"123455678abcd.us.portal.konghq.com","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}]},"additionalProperties":false,"required":["data","meta"]},"ListPortalProductsResponse":{"description":"A paginated list of API products published to a portal.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublishedAPIProduct"}}},"example":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"9cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4},{"id":"6d8cba18-5bdf-4936-81de-d76da02cb99b","name":"Utility API","description":"Useful for helping with progress","created_at":"2022-04-24T18:40:35.500Z","updated_at":"2022-09-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"engineering","location":"cyberspace"},"version_count":21}]},"additionalProperties":false,"required":["data","meta"]},"PortalProductFilters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"description":{"$ref":"#/components/schemas/StringFieldFilter"}},"additionalProperties":false,"title":"PortalProductFilters"},"PortalProductVersionFilters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"publish_status":{"$ref":"#/components/schemas/PublishStatusFilter"},"product_version_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"auth_strategy_ids":{"$ref":"#/components/schemas/UuidFieldFilter"},"application_registration_enabled":{"$ref":"#/components/schemas/BooleanFieldFilter"},"auto_approve_registration":{"$ref":"#/components/schemas/BooleanFieldFilter"},"deprecated":{"$ref":"#/components/schemas/BooleanFieldFilter"}},"additionalProperties":false,"title":"PortalProductVersionFilters"},"PortalProductVersionPublishStatus":{"description":"Publication status of the API product version on the portal","type":"string","enum":["published","unpublished"]},"PortalProductVersionDeprecated":{"description":"Whether the api product version on the portal is deprecated","type":"boolean"},"NotifyDevelopers":{"description":"Whether to notify developers who are affected by this change","type":"boolean","title":"NotifyDevelopers"},"PublishStatusFilter":{"description":"Filters on the given publish status","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"PublishStatusFilter","x-examples":{"example-1":"published","example-2":{"eq":"unpublished"},"example-3":{"neq":"unpublished"}}},"ApplicationRegistrationEnabled":{"description":"Whether the application registration on this portal for the api product version is enabled","type":"boolean"},"AutoApproveRegistration":{"description":"Whether the application registration auto approval on this portal for the api product version is enabled","type":"boolean"},"AuthStrategies":{"description":"A list of authentication strategies","type":"array","items":{"$ref":"#/components/schemas/AuthStrategy"},"maxItems":1,"minItems":0},"AuthStrategyIDs":{"description":"A list of authentication strategy IDs","type":"array","items":{"$ref":"#/components/schemas/UUID_RW"},"maxItems":1,"minItems":0},"PublishAPIProductPayload":{"description":"Payload to publish/unpublish multiple API products","type":"object","properties":{"api_products":{"type":"object","additionalProperties":{"type":"object","nullable":true,"properties":{"publish_status":{"type":"string","enum":["published","unpublished"]}},"required":["publish_status"]},"nullable":false}},"additionalProperties":false,"required":["api_products"],"title":"PublishAPIProductPayload,"},"CreatePortalProductVersionPayload":{"description":"Payload to create a Portal Product Version","type":"object","properties":{"publish_status":{"$ref":"#/components/schemas/PortalProductVersionPublishStatus"},"product_version_id":{"$ref":"#/components/schemas/UUID_RW"},"auth_strategy_ids":{"$ref":"#/components/schemas/AuthStrategyIDs"},"application_registration_enabled":{"$ref":"#/components/schemas/ApplicationRegistrationEnabled"},"auto_approve_registration":{"$ref":"#/components/schemas/AutoApproveRegistration"},"deprecated":{"$ref":"#/components/schemas/PortalProductVersionDeprecated"}},"additionalProperties":false,"required":["publish_status","application_registration_enabled","auto_approve_registration","product_version_id","deprecated","auth_strategy_ids"],"title":"CreatePortalProductVersionPayload"},"ReplacePortalProductVersionPayload":{"description":"Payload to update a Portal Product Version","type":"object","properties":{"publish_status":{"$ref":"#/components/schemas/PortalProductVersionPublishStatus"},"auth_strategy_ids":{"$ref":"#/components/schemas/AuthStrategyIDs"},"application_registration_enabled":{"$ref":"#/components/schemas/ApplicationRegistrationEnabled"},"auto_approve_registration":{"$ref":"#/components/schemas/AutoApproveRegistration"},"deprecated":{"$ref":"#/components/schemas/PortalProductVersionDeprecated"},"notify_developers":{"$ref":"#/components/schemas/NotifyDevelopers"}},"additionalProperties":false,"required":["publish_status","application_registration_enabled","auto_approve_registration","deprecated","auth_strategy_ids"],"title":"ReplacePortalProductVersionPayload"},"UpdatePortalProductVersionPayload":{"description":"Payload to update a Portal Product Version","type":"object","properties":{"publish_status":{"$ref":"#/components/schemas/PortalProductVersionPublishStatus"},"auth_strategy_ids":{"$ref":"#/components/schemas/AuthStrategyIDs"},"application_registration_enabled":{"$ref":"#/components/schemas/ApplicationRegistrationEnabled"},"auto_approve_registration":{"$ref":"#/components/schemas/AutoApproveRegistration"},"deprecated":{"$ref":"#/components/schemas/PortalProductVersionDeprecated"},"notify_developers":{"$ref":"#/components/schemas/NotifyDevelopers"}},"additionalProperties":false,"title":"UpdatePortalProductVersionPayload"},"PortalProductVersion":{"description":"A Portal Product Version holds metadata that describes how a Product Version is configured for a specific portal.\n\nIt contains:\n- Lifecyle and deprecation statuses\n- Application registration settings like auto approve or whether application registration is enabled\n- The Authentication Strategy (if present) that is enabled for Application Registration\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"publish_status":{"$ref":"#/components/schemas/PortalProductVersionPublishStatus"},"product_version_id":{"$ref":"#/components/schemas/UUID_RW"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"auth_strategies":{"$ref":"#/components/schemas/AuthStrategies"},"application_registration_enabled":{"$ref":"#/components/schemas/ApplicationRegistrationEnabled"},"auto_approve_registration":{"$ref":"#/components/schemas/AutoApproveRegistration"},"deprecated":{"$ref":"#/components/schemas/PortalProductVersionDeprecated"}},"additionalProperties":false,"required":["id","publish_status","application_registration_enabled","auto_approve_registration","product_version_id","deprecated","auth_strategies","created_at","updated_at"],"title":"PortalProductVersion"},"ListPortalProductVersions":{"description":"A paginated list response for a collection of portal product versions","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalProductVersion"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"],"title":"ListPortalProductVersions"},"PublishedAPIProduct":{"type":"object","properties":{"id":{"description":"The API product ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"description":"The name of the API product","type":"string","example":"My Name"},"description":{"description":"The description of the API product","type":"string","example":"MyDescription","nullable":true},"portal_ids":{"description":"The list of portal identifiers which this API product is published to","type":"array","items":{"type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"minItems":0,"nullable":false,"uniqueItems":true},"version_count":{"description":"The number of published product versions attached to this API product","type":"number","example":10},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"labels":{"$ref":"#/components/schemas/Labels"}},"example":{"id":"7cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4},"additionalProperties":false,"required":["id","name","description","portal_ids","created_at","updated_at","labels","version_count"],"title":"PublishedApiProduct"},"GetPortalResponse":{"$ref":"#/components/schemas/Portal"},"UpdatePortalResponse":{"$ref":"#/components/schemas/Portal"},"CreatePortalResponse":{"$ref":"#/components/schemas/Portal"},"GetAppearanceDefaultsResponse":{"$ref":"#/components/schemas/AppearanceDefaults"},"GetPortalAppearanceResponse":{"example":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come on in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}},"allOf":[{"$ref":"#/components/schemas/PortalAppearance"},{"type":"object","required":["theme_name","use_custom_fonts","custom_theme","custom_fonts","text","images"]}]},"UpdatePortalAppearanceResponse":{"example":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come on in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}},"allOf":[{"$ref":"#/components/schemas/PortalAppearance"},{"type":"object","required":["theme_name","use_custom_fonts","custom_theme","custom_fonts","text","images"]}]},"GetPortalAppearanceLogoResponse":{"type":"string","format":"binary","example":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","title":"GetPortalAppearanceLogoResponse"},"GetPortalAppearanceCatalogCoverResponse":{"type":"string","format":"binary","example":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","title":"GetPortalAppearanceLogoResponse"},"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","application_count":8,"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","application_count":27,"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","application_count":0,"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","application_count":1,"created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}]},"additionalProperties":false,"required":["data","meta"]},"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","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":2,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"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)","reference_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":3,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":["openid"],"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"John Dev","email":"john.developer@example.com"},"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z"}]},"additionalProperties":false,"required":["data","meta"]},"UpdateDeveloperResponse":{"$ref":"#/components/schemas/PortalDeveloper"},"GetDeveloperResponse":{"$ref":"#/components/schemas/PortalDeveloper"},"GetApplicationResponse":{"$ref":"#/components/schemas/Application"},"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v0"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":null,"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v2"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid","read:myscope"],"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":[],"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}]},"additionalProperties":false,"required":["data","meta"],"title":"ListApplicationRegistrationsResponse"},"ListGrantedScopesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}}},"example":{"data":["profile","vault"]},"additionalProperties":false,"required":["data"],"title":"ListGrantedScopesResponse"},"GetApplicationRegistrationResponse":{"$ref":"#/components/schemas/ApplicationRegistration"},"UpdateApplicationRegistrationResponse":{"$ref":"#/components/schemas/ApplicationRegistration"},"VerifyPortalDomainsResponse":{"description":"Details about the current status of a custom domain.","type":"object","properties":{"is_cname_verified":{"type":"boolean","readOnly":true},"is_ssl_issued":{"type":"boolean","readOnly":true}},"example":{"is_cname_verified":true,"is_ssl_issued":false},"additionalProperties":false,"required":["is_cname_verified","is_ssl_issued"],"title":"VerifyPortalDomainsResponse"},"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"},"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"},"application_count":{"type":"number","example":4,"readOnly":true}},"example":{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","application_count":3,"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","application_count"],"title":"PortalDeveloper"},"Application":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"The unique (per developer) name of the application.","type":"string"},"description":{"description":"A description of the application.","type":"string","nullable":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"reference_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 product version 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"]},"developer":{"description":"Information about the developer that owns the application.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the developer that created the application.","type":"string"},"email":{"description":"The email of the developer that created the application.","type":"string"}},"required":["id","name","email"]},"auth_strategy":{"$ref":"#/components/schemas/AuthStrategy"},"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}},"example":{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"},"additionalProperties":false,"required":["id","created_at","updated_at","name","description","reference_id","registration_count","dcr_provider","portal","developer","labels","granted_scopes"],"title":"Application"},"ApplicationRegistration":{"description":"A application's registration for a specific version of a product.","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"},"product":{"description":"Details about the product the application is registered to.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the product the application is registered to.","type":"string"}},"required":["id","name"]},"product_version":{"description":"Details about the version of the product the application is registered to.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the product version associated with the product the application is registered to.","type":"string"}},"required":["id","name"]},"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"]},"developer":{"description":"Details about the developer that owns the application the registration is part of.","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the developer that created the registration.","type":"string"}},"required":["id","name"]},"granted_scopes":{"description":"Cached list of granted scopes for the registration. Identical for all registrations of an applications, use `/portals/{portalId}/applications/{applicationId}` to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.","type":"array","items":{"type":"string"},"deprecated":true,"nullable":true}},"example":{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"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","product","product_version","application","developer","granted_scopes"],"title":"ApplicationRegistration"},"Portal":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"$ref":"#/components/schemas/PortalName"},"display_name":{"$ref":"#/components/schemas/PortalDisplayName"},"description":{"$ref":"#/components/schemas/PortalDescription"},"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},"is_public":{"description":"Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.","type":"boolean"},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.","type":"boolean"},"auto_approve_applications":{"description":"Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"auto_approve_developers":{"description":"Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"custom_domain":{"description":"The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.","type":"string","format":"hostname","nullable":true},"custom_client_domain":{"description":"The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.","type":"string","format":"hostname","nullable":true},"default_application_auth_strategy_id":{"$ref":"#/components/schemas/DefaultApplicationAuthStratID"},"labels":{"$ref":"#/components/schemas/Labels"},"application_count":{"description":"Number of applications created in the portal.","type":"number"},"developer_count":{"description":"Number of developers using the portal.","type":"number"},"published_product_count":{"description":"Number of api products published to the portal","type":"number"}},"example":{"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","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0},"additionalProperties":false,"required":["id","created_at","updated_at","name","display_name","default_domain","is_public","rbac_enabled","auto_approve_applications","auto_approve_developers","custom_domain","custom_client_domain","description","application_count","developer_count","published_product_count"]},"PortalDescription":{"description":"The description of the portal.","type":"string","maxLength":512,"nullable":true},"DefaultApplicationAuthStratID":{"description":"Default strategy ID applied on applications for the portal","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","nullable":true},"CreatePortalRequest":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PortalName"},"display_name":{"$ref":"#/components/schemas/PortalDisplayName"},"description":{"$ref":"#/components/schemas/PortalDescription"},"is_public":{"description":"Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.","type":"boolean"},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.","type":"boolean"},"auto_approve_applications":{"description":"Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"auto_approve_developers":{"description":"Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"custom_domain":{"description":"The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.","type":"string","format":"hostname","maxLength":1024,"nullable":true},"custom_client_domain":{"description":"The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available.  `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.","type":"string","format":"hostname","maxLength":1024,"nullable":true},"default_application_auth_strategy_id":{"$ref":"#/components/schemas/DefaultApplicationAuthStratID"},"labels":{"$ref":"#/components/schemas/Labels"}},"example":{"name":"DevPortal","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":false,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","default_application_auth_strategy_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"additionalProperties":false,"required":["name"]},"PortalName":{"description":"The name of the portal, used to distinguish it from other portals. Name must be unique.","type":"string","maxLength":255,"minLength":1},"PortalDisplayName":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","maxLength":255,"minLength":1},"UpdatePortalRequest":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PortalName"},"display_name":{"$ref":"#/components/schemas/PortalDisplayName"},"description":{"$ref":"#/components/schemas/PortalDescription"},"is_public":{"description":"Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.","type":"boolean"},"rbac_enabled":{"description":"Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.","type":"boolean"},"auto_approve_applications":{"description":"Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"auto_approve_developers":{"description":"Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.","type":"boolean"},"custom_domain":{"description":"The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.","type":"string","format":"hostname","maxLength":1024,"nullable":true},"custom_client_domain":{"description":"The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available.  `custom_domain` must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.","type":"string","format":"hostname","maxLength":1024,"nullable":true},"default_application_auth_strategy_id":{"$ref":"#/components/schemas/DefaultApplicationAuthStratID"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"}},"example":{"name":"Aperture","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":false,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","default_application_auth_strategy_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"additionalProperties":false},"UpdateDeveloperRequest":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/DeveloperStatus"}},"example":{"status":"approved"},"additionalProperties":false,"title":"UpdateDeveloperRequest"},"UpdateApplicationRegistrationRequest":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ApplicationRegistrationStatus"}},"example":{"status":"rejected"},"additionalProperties":false,"title":"UpdateApplicationRegistrationRequest"},"UpdatePortalAppearanceRequest":{"$ref":"#/components/schemas/PortalAppearance"},"AppearanceDefaults":{"description":"The built-in appearance settings available for portals.","type":"object","properties":{"themes":{"$ref":"#/components/schemas/AppearanceDefaultThemes"},"fonts":{"$ref":"#/components/schemas/AppearanceFonts"},"text":{"$ref":"#/components/schemas/AppearanceTextVariables"}},"example":{"themes":{"mint_rocket":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"dark_mode":{"colors":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}},"fonts":{"base":"Roboto","code":"Roboto Mono","headings":"Lato"},"text":{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}},"additionalProperties":false,"readOnly":true,"required":["themes","fonts","text"],"title":"AppearanceDefaults"},"AppearanceDefaultThemes":{"description":"The set of built-in appearance themes that are provided for portals.","type":"object","properties":{"mint_rocket":{"$ref":"#/components/schemas/AppearanceThemeVariables"},"dark_mode":{"$ref":"#/components/schemas/AppearanceThemeVariables"}},"example":{"mint_rocket":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"dark_mode":{"colors":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}},"additionalProperties":false,"readOnly":true,"required":["mint_rocket","dark_mode"],"title":"AppearanceDefaultThemes"},"AppearanceColorVariable":{"type":"object","properties":{"value":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":512}},"example":{"value":"#000000","description":"The color for a type of thing"},"additionalProperties":false,"required":["value"]},"AppearanceThemeColorVariables":{"type":"object","properties":{"section":{"type":"object","additionalProperties":false,"properties":{"header":{"$ref":"#/components/schemas/AppearanceColorVariable"},"body":{"$ref":"#/components/schemas/AppearanceColorVariable"},"hero":{"$ref":"#/components/schemas/AppearanceColorVariable"},"accent":{"$ref":"#/components/schemas/AppearanceColorVariable"},"tertiary":{"$ref":"#/components/schemas/AppearanceColorVariable"},"stroke":{"$ref":"#/components/schemas/AppearanceColorVariable"},"footer":{"$ref":"#/components/schemas/AppearanceColorVariable"}},"required":["header","body","hero","accent","tertiary","stroke","footer"]},"text":{"type":"object","additionalProperties":false,"properties":{"header":{"$ref":"#/components/schemas/AppearanceColorVariable"},"hero":{"$ref":"#/components/schemas/AppearanceColorVariable"},"headings":{"$ref":"#/components/schemas/AppearanceColorVariable"},"primary":{"$ref":"#/components/schemas/AppearanceColorVariable"},"secondary":{"$ref":"#/components/schemas/AppearanceColorVariable"},"accent":{"$ref":"#/components/schemas/AppearanceColorVariable"},"link":{"$ref":"#/components/schemas/AppearanceColorVariable"},"footer":{"$ref":"#/components/schemas/AppearanceColorVariable"}},"required":["header","hero","headings","primary","secondary","accent","link","footer"]},"button":{"type":"object","additionalProperties":false,"properties":{"primary_fill":{"$ref":"#/components/schemas/AppearanceColorVariable"},"primary_text":{"$ref":"#/components/schemas/AppearanceColorVariable"}},"required":["primary_fill","primary_text"]}},"example":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}},"additionalProperties":false,"required":["section","text","button"]},"AppearanceThemeVariables":{"description":"Groups of variables for configuring visual details of the portal user interface. Set theme_name to 'custom' to use custom values for theme variables.","type":"object","properties":{"colors":{"$ref":"#/components/schemas/AppearanceThemeColorVariables"}},"example":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"additionalProperties":false,"required":["colors"],"title":"AppearanceThemeVariables"},"NullableAppearanceThemeVariables":{"description":"Groups of variables for configuring visual details of the portal user interface. Set theme_name to 'custom' to use custom values for theme variables.","type":"object","properties":{"colors":{"$ref":"#/components/schemas/AppearanceThemeColorVariables"}},"example":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"additionalProperties":false,"nullable":true,"required":["colors"],"title":"AppearanceThemeVariables"},"AppearanceFonts":{"description":"Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.","type":"object","properties":{"base":{"$ref":"#/components/schemas/AppearanceFontName"},"code":{"$ref":"#/components/schemas/AppearanceFontName"},"headings":{"$ref":"#/components/schemas/AppearanceFontName"}},"additionalProperties":false,"required":["base","code","headings"]},"NullableAppearanceFonts":{"description":"Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.","type":"object","properties":{"base":{"$ref":"#/components/schemas/AppearanceFontName"},"code":{"$ref":"#/components/schemas/AppearanceFontName"},"headings":{"$ref":"#/components/schemas/AppearanceFontName"}},"additionalProperties":false,"nullable":true,"required":["base","code","headings"]},"AppearanceFontName":{"description":"The name of the font to render in the browser.","type":"string","example":"Roboto","enum":["Roboto","Inter","Open Sans","Lato","Slabo 27px","Slabo 13px","Oswald","Source Sans Pro","Montserrat","Raleway","PT Sans","Lora","Roboto Mono","Inconsolata","Source Code Pro","PT Mono","Ubuntu Mono","IBM Plex Mono"]},"AppearanceImage":{"description":"The image data to upload, along with an optional filename. 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":{"oneOf":[{"$ref":"#/components/schemas/ImagePNGDataUri"},{"$ref":"#/components/schemas/ImageJPGDataUri"},{"$ref":"#/components/schemas/ImageGIFDataUri"},{"$ref":"#/components/schemas/ImageICODataUri"}]},"filename":{"type":"string","maxLength":512}},"example":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"additionalProperties":false,"nullable":true,"required":["data"]},"AppearanceImages":{"description":"A collection of binary image data to customize images in the portal","type":"object","properties":{"logo":{"$ref":"#/components/schemas/AppearanceImage"},"favicon":{"$ref":"#/components/schemas/AppearanceImage"},"catalog_cover":{"$ref":"#/components/schemas/AppearanceImage"}},"example":{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}},"additionalProperties":false,"nullable":true},"AppearanceTextVariables":{"description":"Values to display for customizable text in the portal user interface","type":"object","properties":{"catalog":{"type":"object","additionalProperties":false,"properties":{"welcome_message":{"type":"string","maxLength":512},"primary_header":{"type":"string","maxLength":512}},"required":["welcome_message","primary_header"]}},"additionalProperties":false,"required":["catalog"]},"NullableAppearanceTextVariables":{"description":"Values to display for customizable text in the portal user interface","type":"object","properties":{"catalog":{"type":"object","additionalProperties":false,"properties":{"welcome_message":{"type":"string","maxLength":512},"primary_header":{"type":"string","maxLength":512}},"required":["welcome_message","primary_header"]}},"example":{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}},"additionalProperties":false,"nullable":true,"required":["catalog"]},"PortalAppearance":{"type":"object","properties":{"theme_name":{"$ref":"#/components/schemas/PortalTheme"},"custom_theme":{"$ref":"#/components/schemas/NullableAppearanceThemeVariables"},"custom_fonts":{"$ref":"#/components/schemas/NullableAppearanceFonts"},"use_custom_fonts":{"description":"If true, fonts in custom_fonts will be used over the theme's default fonts","type":"boolean","nullable":false},"text":{"$ref":"#/components/schemas/NullableAppearanceTextVariables"},"images":{"$ref":"#/components/schemas/AppearanceImages"}},"example":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come one in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}},"additionalProperties":false},"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"},"ApplicationRegistrationStatus":{"description":"The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.\nPending, revoked, and rejected registrations will not provide access to the product version.","type":"string","example":"approved","enum":["approved","pending","revoked","rejected"],"title":"ApplicationRegistrationStatus"},"PortalTheme":{"description":"Select a pre-existing default theme or specify 'custom' to use custom_theme variables.","type":"string","example":"mint_rocket","enum":["mint_rocket","dark_mode","custom"]},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","oneOf":[{"type":"string"},{"type":"object","title":"StringFieldEqualsComparison","additionalProperties":false,"properties":{"eq":{"type":"string"}},"required":["eq"]}],"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"StringFieldOEQFilter":{"description":"Returns entities that exact match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"oeq":{"type":"string"}},"additionalProperties":false,"required":["oeq"],"title":"StringFieldOEQFilter","x-examples":{"example-1":{"oeq":"some-value,some-other-value"}}},"StringFieldNEQFilter":{"description":"Filters on the given string field value by exact match inequality.","type":"object","properties":{"neq":{"type":"string"}},"additionalProperties":false,"required":["neq"],"title":"StringFieldNEQFilter","x-examples":{"example-1":{"neq":"not-this-value"}}},"UuidFieldFilter":{"description":"Filters on the given UUID field value by exact match.","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"UuidFieldFilter","x-examples":{"example-1":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1","example-2":{"eq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-3":{"oeq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-4":{"neq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"}}},"StringFieldContainsFilter":{"description":"Filters on the given string field value by fuzzy match.","type":"object","properties":{"contains":{"type":"string"}},"additionalProperties":false,"required":["contains"],"title":"StringFieldContainsFilter","x-examples":{"example-1":{"contains":"some-value"}}},"StringFieldOContainsFilter":{"description":"Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"ocontains":{"type":"string"}},"additionalProperties":false,"required":["ocontains"],"title":"StringFieldOContainsFilter","x-examples":{"example-1":{"ocontains":"this-value,or-that-value"}}},"StringFieldFilter":{"description":"Filters on the given string field value by either exact or fuzzy match.","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldContainsFilter"},{"$ref":"#/components/schemas/StringFieldOContainsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"StringFieldFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"},"example-3":{"contains":"some-value"},"example-4":{"ocontains":"some-potential,value"},"example-5":{"oeq":"some-potential,value"},"example-6":{"neq":"not-this-value"}}},"BooleanFieldFilter":{"description":"Filter by a boolean value (true/false).","type":"boolean","title":"BooleanFieldFilter","x-examples":{"example-1":true}},"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"},"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"},"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"}}}]},"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"}}}]},"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},"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"}}}]},"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"}}},"UUID_RW":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"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"]},"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"]},"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>"},"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"}},"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"}},"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."}},"CreateTeamExample1":{"value":{"name":"IDM - Developers","description":"The Identity Management (IDM) API team."}},"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"]}]}},"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"}},"UpdatePortalExampleRbacEnabled":{"value":{"rbac_enabled":true}},"UpdatePortalExamplePublic":{"value":{"is_public":true}},"UpdatePortalExampleAutoApprove":{"value":{"auto_approve_applications":false,"auto_approve_developers":false}},"UpdatePortalExampleCustomDomains":{"value":{"custom_domain":"api.example.com","custom_client_domain":"portal.example.com"}},"UpdatePortalExample1":{"value":{"is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":false,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com"}},"CreatePortalExampleRbacEnabled":{"value":{"name":"MyDevPortal","rbac_enabled":true}},"CreatePortalExamplePublic":{"value":{"name":"MyDevPortal","is_public":true}},"CreatePortalExampleAutoApprove":{"value":{"name":"MyDevPortal","auto_approve_applications":false,"auto_approve_developers":false}},"CreatePortalExampleCustomDomains":{"value":{"name":"MyDevPortal","custom_domain":"api.example.com","custom_client_domain":"portal.example.com"}},"CreatePortalExample1":{"value":{"name":"MyDevPortal","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":false,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com"}},"UpdateApplicationRegistrationApproved":{"value":{"status":"approved"}},"UpdateApplicationRegistrationPending":{"value":{"status":"pending"}},"UpdateApplicationRegistrationRejected":{"value":{"status":"rejected"}},"UpdateApplicationRegistrationRevoked":{"value":{"status":"revoked"}},"UpdatePortalAppearanceExampleMintRocketTheme":{"value":{"theme_name":"mint_rocket","use_custom_fonts":false,"custom_theme":null,"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come one in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}}},"UpdatePortalAppearanceExampleDarkModeTheme":{"value":{"theme_name":"dark_mode","use_custom_fonts":true,"custom_theme":null,"custom_fonts":{"base":"Lato","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Say Hello To Our APIs","primary_header":"Say goodbye to your problems"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}}},"UpdatePortalAppearanceExampleCustomTheme":{"value":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come one in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}}},"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"}},"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"},{"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"},{"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"}]}},"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"}]}},"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","default_domain":"123455678abcd.us.portal.konghq.com","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}]}},"ListPortalProductsExample1":{"value":{"meta":{"page":{"number":1,"size":10,"total":2}},"data":[{"id":"9cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4},{"id":"6d8cba18-5bdf-4936-81de-d76da02cb99b","name":"Utility API","description":"Useful for helping with progress","created_at":"2022-04-24T18:40:35.500Z","updated_at":"2022-09-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"engineering","location":"cyberspace"},"version_count":21}]}},"PortalProductVersionExample1":{"value":{"id":"22f8380e-7798-4566-99e3-2edf2b57d289","publish_status":"published","product_version_id":"33f8380e-7798-4566-99e3-2edf2b57d289","auth_strategies":[{"id":"44f8380e-7798-4566-99e3-2edf2b57d289","name":"key auth strategy","credential_type":"key_auth","key_names":["apikey"]}],"application_registration_enabled":true,"auto_approve_registration":true,"deprecated":false,"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ListPortalProductVersionsExample1":{"value":{"data":[{"id":"22f8380e-7798-4566-99e3-2edf2b57d289","publish_status":"published","product_version_id":"33f8380e-7798-4566-99e3-2edf2b57d289","auth_strategies":[{"id":"44f8380e-7798-4566-99e3-2edf2b57d289","name":"key auth strategy","credential_type":"key_auth","key_names":["apikey"]}],"application_registration_enabled":true,"auto_approve_registration":true,"deprecated":false,"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}},"PortalProductVersionCreateRequestExample1":{"value":{"product_version_id":"33f8380e-7798-4566-99e3-2edf2b57d289","auth_strategy_ids":["44f8380e-7798-4566-99e3-2edf2b57d289"],"publish_status":"published","application_registration_enabled":true,"auto_approve_registration":true,"deprecated":false}},"PortalProductVersionUpdateRequestExample1":{"value":{"auto_approve_registration":false}},"PortalProductVersionReplaceRequestExample1":{"value":{"auth_strategy_ids":["44f8380e-7798-4566-99e3-2edf2b57d289"],"publish_status":"published","application_registration_enabled":true,"auto_approve_registration":true,"deprecated":false}},"PortalProductVersionUpdateAuthStrategyExample":{"value":{"auth_strategy_ids":["44f8380e-7798-4566-99e3-2edf2b57d289"]}},"GetPortalExample1":{"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","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}},"UpdatePortalResponseExample1":{"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","is_public":false,"rbac_enabled":true,"auto_approve_applications":false,"auto_approve_developers":true,"custom_domain":"api.example.com","custom_client_domain":"portal.example.com","application_count":0,"developer_count":0,"published_product_count":0}},"VerifyPortalDomainsExample1":{"value":{"is_cname_verified":true,"is_ssl_issued":false}},"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","application_count":8,"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","application_count":27,"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","application_count":0,"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","application_count":1,"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","application_count":3,"created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}},"UpdateDeveloperResponseExample1":{"value":{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","application_count":3,"created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}},"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","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":2,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"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)","reference_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":3,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":["openid"],"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"John Dev","email":"john.developer@example.com"},"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","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"}},"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 using Dynamic Client Registration (DCR)","reference_id":"yr1k0d9kj3l0cl01hp4o0","registration_count":1,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":{"id":"7ea06071-49c7-4c2e-ae49-8a86d72a8110"},"granted_scopes":["openid"],"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"John Dev","email":"john.developer@example.com"},"created_at":"2022-12-22T19:07:30.712Z","updated_at":"2022-12-22T19:07:30.712Z"}},"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v0"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":null,"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v2"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid","read:myscope"],"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"},"product":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Good Product"},"product_version":{"id":"64e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":[],"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"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"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"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}},"ListGrantedScopesExample1":{"value":{"data":["profile","vault"]}},"GetAppearanceDefaultsExample1":{"value":{"themes":{"mint_rocket":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"dark_mode":{"colors":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}},"fonts":{"base":"Roboto","code":"Roboto Mono","headings":"Lato"},"text":{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}}},"GetPortalAppearanceExample1":{"value":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come on in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}}},"UpdatePortalAppearanceResponseExample1":{"value":{"theme_name":"custom","use_custom_fonts":true,"custom_theme":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"custom_fonts":{"base":"Roboto","code":"Roboto","headings":"Roboto"},"text":{"catalog":{"welcome_message":"Welcome","primary_header":"Come on in!"}},"images":{"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"favicon.ico"},"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=","filename":"logo.png"},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}}},"VerifyPortalDomainsBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"custom_domain","reason":"portal needs a custom_domain to be verified"}]}},"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":"is_public","rule":"is_boolean","reason":"value of \"is_public\" 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"}]}},"UpdatePortalBadRequestExample6":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"custom_domain","rule":"max_length","reason":"value of \"custom_domain\" must not exceed 1024 characters","source":"body","maximum":1024}]}},"UpdatePortalBadRequestExample7":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"custom_client_domain","rule":"max_length","reason":"value of \"custom_client_domain\" must not exceed 1024 characters","source":"body","maximum":1024}]}},"DeletePortalBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"force","rule":"required","reason":"This Portal has 30 developers, 10 gateway-linked API product versions with active auth strategies. These must be individually removed before deletion or the force=true query param can be used to automatically delete associated entities.”","source":"query"}]}},"ListPortalProductsBadRequestExample1":{"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"}]}},"ListPortalProductsBadRequestExample2":{"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"}]}},"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"}]}},"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"}]}},"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"}]}},"UpdateAppearanceConfigurationBadRequestExample1":{"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"}]}},"UpdateAppearanceConfigurationBadRequestExample2":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"use_custom_fonts","rule":"is_boolean","reason":"value of \"use_custom_fonts\" must be true or false","source":"body"}]}},"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","sg","*"],"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"}]}},"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"}]}},"GetPortalLogoResponseExample1":{"value":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"GetPortalLogoResponseExample2":{"value":"data:image/jpg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"GetPortalCatalogCoverResponseExample1":{"value":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"GetPortalCatalogCoverResponseExample2":{"value":"data:image/jpg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"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"}},"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":{"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"}}}}},"CreatePortal":{"description":"Create a portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/CreatePortalExample1"},"Public Portal":{"$ref":"#/components/examples/CreatePortalExamplePublic"},"Enable RBAC":{"$ref":"#/components/examples/CreatePortalExampleRbacEnabled"},"Auto Approve Settings":{"$ref":"#/components/examples/CreatePortalExampleAutoApprove"},"Custom Domains":{"$ref":"#/components/examples/CreatePortalExampleCustomDomains"}}}}},"UpdatePortal":{"description":"Update a portal's settings.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalExample1"},"Public Portal":{"$ref":"#/components/examples/UpdatePortalExamplePublic"},"Enable RBAC":{"$ref":"#/components/examples/UpdatePortalExampleRbacEnabled"},"Auto Approve Settings":{"$ref":"#/components/examples/UpdatePortalExampleAutoApprove"},"Custom Domains":{"$ref":"#/components/examples/UpdatePortalExampleCustomDomains"}}}}},"PublishAPIProducts":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishAPIProductPayload"},"example":{"api_products":{"820772b2-0c93-4a9c-8c5e-c2ccc63b3340":{"publish_status":"published"},"9b4f4829-d540-4a3a-aefc-839852bdb3e8":{"publish_status":"unpublished"},"edf3d192-3591-4b03-ac0b-69bad1fcba05":null}}}}},"CreatePortalProductVersion":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalProductVersionPayload"},"examples":{"PortalProductVersion":{"$ref":"#/components/examples/PortalProductVersionCreateRequestExample1"}}}}},"UpdatePortalProductVersion":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalProductVersionPayload"},"examples":{"PortalProductVersion":{"$ref":"#/components/examples/PortalProductVersionUpdateRequestExample1"},"PortalProductVersionUpdateAuthStrategy":{"$ref":"#/components/examples/PortalProductVersionUpdateAuthStrategyExample"}}}}},"ReplacePortalProductVersion":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacePortalProductVersionPayload"},"examples":{"PortalProductVersion":{"$ref":"#/components/examples/PortalProductVersionReplaceRequestExample1"}}}}},"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"}}}}},"UpdatePortalAppearance":{"description":"Update a portal's appearance settings","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalAppearanceRequest"},"examples":{"Custom Theme":{"$ref":"#/components/examples/UpdatePortalAppearanceExampleCustomTheme"},"Mint Rocket Theme":{"$ref":"#/components/examples/UpdatePortalAppearanceExampleMintRocketTheme"},"Dark Mode Theme":{"$ref":"#/components/examples/UpdatePortalAppearanceExampleDarkModeTheme"}}}}},"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"}}}}},"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":{"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}}}}}},"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"}}}}},"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"}}}}},"PortalReplayJobBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"PortalReplayJobConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Job Running":{"$ref":"#/components/examples/409-job-running"}}}}},"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"}}}}},"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"}}}}},"ListPortals":{"description":"A paginated list of portals in the current region of an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalsExample1"}}}}},"ListPortalProducts":{"description":"A paginated list of API products published to a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalProductsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListPortalProductsExample1"}}}}},"ListPortalProductVersions":{"description":"A response containing a list of portal product versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPortalProductVersions"},"examples":{"PortalProductVersion":{"$ref":"#/components/examples/ListPortalProductVersionsExample1"}}}}},"PortalProductVersion":{"description":"A response containing a portal product version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalProductVersion"},"examples":{"PortalProductVersion":{"$ref":"#/components/examples/PortalProductVersionExample1"}}}}},"GetPortal":{"description":"Details about a portal and its current settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPortalResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetPortalExample1"}}}}},"UpdatePortal":{"description":"Details about the portal being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalResponseExample1"}}}}},"CreatePortal":{"description":"Details about the portal that was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalResponseExample1"}}}}},"VerifyPortalDomains":{"description":"Details about the status of a portal's custom domain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyPortalDomainsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/VerifyPortalDomainsExample1"}}}}},"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"}}}}},"GetDeveloper":{"description":"Details about a developer in a portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeveloperResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetDeveloperExample1"}}}}},"UpdateDeveloper":{"description":"Details about the developer being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeveloperResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdateDeveloperResponseExample1"}}}}},"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":{"Basic Application (No DCR with Identity Provider)":{"$ref":"#/components/examples/GetApplicationExampleBasic"},"Using DCR with Identity Provider":{"$ref":"#/components/examples/GetApplicationExampleDcr"}}}}},"ListApplicationRegistrations":{"description":"A paginated list of application registrations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationRegistrationsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListApplicationRegistrationsExample1"}}}}},"ListGrantedScopes":{"description":"A list of granted scopes for an application registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGrantedScopesResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/ListGrantedScopesExample1"}}}}},"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"}}}}},"GetAppearanceDefaults":{"description":"A set of built-in appearance settings for developer portals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppearanceDefaultsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetAppearanceDefaultsExample1"}}}}},"GetPortalAppearance":{"description":"Details about a portal's current appearance settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPortalAppearanceResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetPortalAppearanceExample1"}}}}},"UpdatePortalAppearance":{"description":"Details about the appearance settings being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePortalAppearanceResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdatePortalAppearanceResponseExample1"}}}}},"GetPortalLogoResponse":{"description":"Logo of the portal. Can be either png or jpg","content":{"image/jpg":{"schema":{"$ref":"#/components/schemas/GetPortalAppearanceLogoResponse"},"examples":{"Example 2":{"$ref":"#/components/examples/GetPortalLogoResponseExample2"}}},"image/png":{"schema":{"$ref":"#/components/schemas/GetPortalAppearanceLogoResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetPortalLogoResponseExample1"}}}}},"GetPortalCatalogCoverResponse":{"description":"Catalog Cover of the portal. Can be either png or jpg","content":{"image/jpg":{"schema":{"$ref":"#/components/schemas/GetPortalAppearanceCatalogCoverResponse"},"examples":{"Example 2":{"$ref":"#/components/examples/GetPortalCatalogCoverResponseExample2"}}},"image/png":{"schema":{"$ref":"#/components/schemas/GetPortalAppearanceCatalogCoverResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetPortalCatalogCoverResponseExample1"}}}}},"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 Developers","description":"APIs related to Konnect Developer Portal Developers."},{"name":"Portal Teams","description":"APIs related to Konnect Developer Portal Developer Teams."},{"name":"Portal Team Membership","description":"APIs related to Developer Membership in Konnect Developer Portal Developer Teams."},{"name":"Portal Team Roles","description":"APIs related to Team Roles in Konnect Developer Portal."},{"name":"Portal Applications","description":"APIs related to Konnect Developer Portal Applications."},{"name":"Portal Application Registrations","description":"APIs related to Konnect Developer Portal Application Registrations."},{"name":"Portal Products","description":"APIs related to API Products Published to Konnect Developer Portals."},{"name":"Portal Auth Settings","description":"APIs related to Konnect Developer Portal Authentication Settings."},{"name":"Portal Appearance","description":"APIs related to Konnect Developer Portal Appearance Settings."},{"name":"Portal Product Versions","description":"Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal.\n\n  They contain:\n  - Lifecyle and deprecation statuses\n  - Application registration settings like auto approve or whether application registration is enabled\n  - The authentication strategy that is enabled for Application Registration\n"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
