CreateDeveloperRequest

object

Request body for creating a developer in a portal.

* Additional properties are NOT allowed.
emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstring

When omitted, the portal’s auto_approve_developers setting determines the initial status. Set this property to override the portal default with any valid developer status.

Allowed values:approvedpendingrevokedrejected

Example:approved

send_invitation_emailboolean

When true, sends an invitation email to the developer. Default is false; no emails are sent unless explicitly requested.

Default:false

Example

PortalDeveloper

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

emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstringrequired

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.

Allowed values:approvedpendingrevokedrejected

Example:approved

Example

DeveloperStatus

string

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.

Allowed values:approvedpendingrevokedrejected

Example

CreateApplicationRequest

object
* Additional properties are NOT allowed.
namestringrequired

The name of the application.

<= 255 characters

descriptionstring

A description of the application.

<= 255 characters

labelsobject

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

dcr_client_idstring

If using a DCR auth strategy, set this property to link the portal application to an existing
client from the DCR provider, instead of having Konnect create a new client.
This allows importing existing clients from an Identity Provider into Konnect, allowing
them to be controlled through the DCR flows in the portal, and use existing client secrets
for API access.
The value must be a valid client ID in the DCR provider associated with the auth strategy.
If it is not valid, application will be created but will not function properly.

<= 255 characters

client_idstring

An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.

<= 255 characters

auth_strategy_idstring(uuid)

The ID of the authentication strategy the application will use when making requests to registered APIs.

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

GetApplicationResponse

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