Application
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The unique (per developer) name of the application.
A description of the application.
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
The ID used to linked the portal application to an Identity Provider application.
The number of product version registrations that are associated with the application. Registrations of any status are included in the count.
Information about the DCR provider this application uses, if using DCR.
Show Child Parameters
Information about the portal the application is in.
Show Child Parameters
Information about the developer that owns the application.
Show Child Parameters
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
List of granted scopes for the application. Null if application type does not support returning granted scopes.
ApplicationRegistration
objectA application’s registration for a specific version of a product.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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.
Pending, revoked, and rejected registrations will not provide access to the product version.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the product the application is registered to.
Show Child Parameters
Details about the version of the product the application is registered to.
Show Child Parameters
Details about the application the registration is part of.
Show Child Parameters
Details about the developer that owns the application the registration is part of.
Show Child Parameters
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.
Portal
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The name of the portal, used to distinguish it from other portals. Name must be unique.
>= 1 characters<= 255 characters
The display name of the portal. This value will be the portal’s name in Portal API.
>= 1 characters<= 255 characters
The description of the portal.
<= 512 characters
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``.
Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.
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.
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.
Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.
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.
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.
Default strategy ID applied on applications for the portal
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Number of applications created in the portal.
Number of developers using the portal.
Number of api products published to the portal
PortalDescription
stringThe description of the portal.
<= 512 characters
DefaultApplicationAuthStratID
stringDefault strategy ID applied on applications for the portal