Application

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

client_idstringrequiredread-only

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

registration_countnumberrequiredread-only

The number of API 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
auth_strategyobjectrequired

Client Credential 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.

ownerobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

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

client_idstringrequiredread-only

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

registration_countnumberrequiredread-only

The number of API 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
auth_strategyobjectrequired

Client Credential 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.

ownerobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

Key Auth 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 name of the application.

descriptionstringrequired

A description of the application.

auth_strategyobjectrequired

KeyAuth Auth strategy that the application uses.

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

registration_countnumberrequiredread-only

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

ownerobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ApplicationRegistration

object

A application’s registration for a specific version of an API.

* 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 API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.

Allowed values:approvedpendingrevokedrejected

Example:approved

apiobjectrequired

Details about the API 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
Example

ApplicationRegistrationStatus

string

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.

Allowed values:approvedpendingrevokedrejected

Example