Portal Application Registration

For example, configure this plugin on a service by making the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=application-registration"  \
    --data "config.auth_header_name=authorization" \
    --data "config.auto_approve=false" \
    --data "config.display_name=<my_service_display_name>" \
    --data "config.enable_authorization_code=true" \
    --data "config.enable_client_credentials=true" \
    --data "config.enable_implicit_grant=true" \
    --data "config.enable_password_grant=true" \
    --data "config.mandatory_scope=false" \
    --data "config.refresh_token_ttl=1209600" \
    --data "config.token_expiration=7200"

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <application-registration-example>
config: 
  auth_header_name: authorization
  auto_approve: false
  display_name: <my_service_display_name>
  enable_authorization_code: true
  enable_client_credentials: true
  enable_implicit_grant: true
  enable_password_grant: true
  mandatory_scope: false
  refresh_token_ttl: 1209600
  token_expiration: 7200
plugin: application-registration

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <application-registration-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

{SERVICE} is the id or name of the service that this plugin configuration will target.

For example, configure this plugin on a service by adding this section to your declarative configuration file:

plugins:
- name: application-registration
  service: {SERVICE}
  config: 
    auth_header_name: authorization
    auto_approve: false
    display_name: <my_service_display_name>
    enable_authorization_code: true
    enable_client_credentials: true
    enable_implicit_grant: true
    enable_password_grant: true
    mandatory_scope: false
    refresh_token_ttl: 1209600
    token_expiration: 7200

SERVICE is the id or name of the service that this plugin configuration will target.

Configure this plugin on a service:

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Services and click View for the service row.
3. Scroll down to plugins and click Add Plugin.

4. Find and select the Portal Application Registration plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, select Scoped.
6. Add the service name and ID to the Service field if it is not already prefilled.

7. Enter the following parameters, updating the default or sample values as needed:

   • Config.Auto Approve: clear checkbox
   • Config.Display Name: <my_service_display_name>
   • Config.Enable Authorization Code: select checkbox
   • Config.Enable Client Credentials: select checkbox
   • Config.Enable Implicit Grant: select checkbox
   • Config.Enable Password Grant: select checkbox
   • Config.Mandatory Scope: clear checkbox
   • Config.Refresh Token Ttl: 1209600
   • Config.Token Expiration: 7200
8. Click Create.

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=application-registration"  \
    --data "config.auth_header_name=authorization" \
    --data "config.auto_approve=false" \
    --data "config.display_name=<my_service_display_name>" \
    --data "config.enable_authorization_code=true" \
    --data "config.enable_client_credentials=true" \
    --data "config.enable_implicit_grant=true" \
    --data "config.enable_password_grant=true" \
    --data "config.mandatory_scope=false" \
    --data "config.refresh_token_ttl=1209600" \
    --data "config.token_expiration=7200"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-application-registration>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  auth_header_name: authorization
  auto_approve: false
  display_name: <my_service_display_name>
  enable_authorization_code: true
  enable_client_credentials: true
  enable_implicit_grant: true
  enable_password_grant: true
  mandatory_scope: false
  refresh_token_ttl: 1209600
  token_expiration: 7200
plugin: application-registration

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: application-registration
  config: 
    auth_header_name: authorization
    auto_approve: false
    display_name: <my_service_display_name>
    enable_authorization_code: true
    enable_client_credentials: true
    enable_implicit_grant: true
    enable_password_grant: true
    mandatory_scope: false
    refresh_token_ttl: 1209600
    token_expiration: 7200

Configure this plugin globally:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Plugins in the left navigation.
3. Click New Plugin.

4. Find and select the Portal Application Registration plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, set the plugin scope to Global.

6. Enter the following parameters, updating the default/sample values as needed:

   • Config.Auto Approve: clear checkbox
   • Config.Display Name: <my_service_display_name>
   • Config.Enable Authorization Code: select checkbox
   • Config.Enable Client Credentials: select checkbox
   • Config.Enable Implicit Grant: select checkbox
   • Config.Enable Password Grant: select checkbox
   • Config.Mandatory Scope: clear checkbox
   • Config.Refresh Token Ttl: 1209600
   • Config.Token Expiration: 7200
7. Click Create.