Application

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The unique (per developer) name of the application.

descriptionstringrequired

A description of the application.

labelsobjectrequired

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"}

reference_idstringrequiredread-only

The ID used to linked the portal application to an Identity Provider application.

registration_countnumberrequiredread-only

The number of product version registrations that are associated with the application. Registrations of any status are included in the count.

dcr_providerobjectrequired

Information about the DCR provider this application uses, if using DCR.

* Additional properties are NOT allowed.
Show Child Parameters
portalobjectrequired

Information about the portal the application is in.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Information about the developer that owns the application.

* Additional properties are NOT allowed.
Show Child Parameters
auth_strategyOne Of
object
AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray[string]required

List of granted scopes for the application. Null if application type does not support returning granted scopes.

Example

ApplicationRegistration

object

A application’s registration for a specific version of a product.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

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

productobjectrequired

Details about the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
product_versionobjectrequired

Details about the version of the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired

Details about the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Details about the developer that owns the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray[string]requiredDEPRECATED

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.

Example

Portal

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The name of the portal, used to distinguish it from other portals. Name must be unique.

>= 1 characters<= 255 characters

display_namestringrequired

The display name of the portal. This value will be the portal’s name in Portal API.

>= 1 characters<= 255 characters

descriptionstringrequired

The description of the portal.

<= 512 characters

default_domainstring(hostname)requiredread-only

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``.

is_publicbooleanrequired

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabledbooleanrequired

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.

auto_approve_applicationsbooleanrequired

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.

auto_approve_developersbooleanrequired

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domainstring(hostname)required

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.

custom_client_domainstring(hostname)required

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_application_auth_strategy_idstring(uuid)

Default strategy ID applied on applications for the portal

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

labelsobject

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"}

application_countnumberrequired

Number of applications created in the portal.

developer_countnumberrequired

Number of developers using the portal.

published_product_countnumberrequired

Number of api products published to the portal

Example

PortalDescription

string

The description of the portal.

<= 512 characters

DefaultApplicationAuthStratID

string

Default strategy ID applied on applications for the portal

Example