Basic Authentication

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

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

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: <basic-auth-example>
config: 
  hide_credentials: true
plugin: basic-auth

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: <basic-auth-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: basic-auth
  service: {SERVICE}
  config: 
    hide_credentials: true

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

Configure this plugin on a service:

1. In Konnect Cloud, select the service on the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Scroll down to Plugins and click New Plugin.
4. Find and select the Basic Authentication plugin.

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

   • Config.Hide Credentials: select checkbox
6. Click Create.

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 Basic Authentication 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.Hide Credentials: select checkbox
8. Click Create.

For example, configure this plugin on a route with:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <basic-auth-example>
config: 
  hide_credentials: true
plugin: basic-auth

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <basic-auth-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

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

plugins:
- name: basic-auth
  route: <route>
  config: 
    hide_credentials: true

ROUTE is the id or name of the route that this plugin configuration will target.

Configure this plugin on a route:

1. In Konnect Cloud, select the service from the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Select the route.
4. Scroll down to Plugins and click Add Plugin.
5. Find and select the Basic Authentication plugin.

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

   • Config.Hide Credentials: select checkbox
7. Click Create.

Configure this plugin on a route:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Routes in the left navigation.
3. Click View for the route row.
4. Scroll down to plugins and click Add Plugin.

5. Find and select the Basic Authentication plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Scoped.
7. Add the Route ID if it is not already prefilled.

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

   • Config.Hide Credentials: select checkbox
9. Click Create.

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-basic-auth>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  hide_credentials: true
plugin: basic-auth

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

plugins:
- name: basic-auth
  config: 
    hide_credentials: true

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 Basic Authentication 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.Hide Credentials: select checkbox
7. Click Create.

To create a Consumer, you can execute the following request:

curl -d "username={USER123}&custom_id={SOME_CUSTOM_ID}" http://kong:8001/consumers/

Your declarative configuration file needs to have one or more Consumers. You can create them using a consumers: YAML section:

consumers:
- username: {USER123}
  custom_id: {SOME_CUSTOM_ID}

You can provision new username/password credentials by making the following HTTP request:

curl -X POST http://kong:8001/consumers/{CONSUMER}/basic-auth \
  --data "username=Aladdin" \
  --data "password=OpenSesame"

You can add credentials on your declarative config file with the basicauth_credentials YAML entry:

basicauth_credentials:
- consumer: {CONSUMER}
  username: Aladdin
  password: OpenSesame