Portal Application Registration Configuration

Configuration

This plugin is not compatible with DB-less mode.

Compatible protocols

The Portal Application Registration plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case application-registration.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example application-registration_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string required

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • display_name

    string required

    Unique display name used for a Service in the Developer Portal.

  • description

    string

    Unique description displayed in information about a Service in the Developer Portal.

  • auto_approve

    boolean required default: false

    If enabled, all new Service Contracts requests are automatically approved.

  • show_issuer

    boolean required default: false

    Displays the Issuer URL in the Service Details dialog.