Configuration

configobjectrequired
Hide Child Parameters
authenticationobject
Hide Child Parameters
mechanismstring

The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.

Allowed values:PLAINSCRAM-SHA-256SCRAM-SHA-512

passwordstring

Password for SASL authentication.
This field is encrypted.
This field is referenceable.

strategystring

The authentication strategy for the plugin, the only option for the value is sasl.

Allowed values:sasl

tokenauthboolean

Enable this to indicate DelegationToken authentication

userstring

Username for SASL authentication.
This field is encrypted.
This field is referenceable.

auto_offset_resetstring

The offset to start from when there is no initial offset in the consumer group.

Allowed values:earliestlatest

Default:latest

bootstrap_serversarray[object]required

Set of bootstrap brokers in a {host: host, port: port} list format.

Hide Child Parameters
hoststringrequired

A string representing a host name, such as example.com.

portintegerrequired

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

cluster_namestring

An identifier for the Kafka cluster.

commit_strategystring

The strategy to use for committing offsets.

Allowed values:autooff

Default:auto

message_deserializerstring

The deserializer to use for the consumed messages.

Allowed values:jsonnoop

Default:noop

modestring

The mode of operation for the plugin.

Allowed values:http-getserver-sent-eventswebsocket

Default:http-get

schema_registryobject

The plugin-global schema registry configuration.

Hide Child Parameters
confluentobject
Hide Child Parameters
authenticationobjectrequired
Show Child Parameters
ssl_verifyboolean

Set to false to disable SSL certificate verification when connecting to the schema registry.

Default:true

ttlnumber

The TTL in seconds for the schema registry cache.

>= 0<= 3600

urlstring

The URL of the schema registry.

securityobject
Hide Child Parameters
certificate_idstring

UUID of certificate entity for mTLS authentication.

sslboolean

Enables TLS.

topicsarray[object]required

The Kafka topics and their configuration you want to consume from.

>= 1 characters

Hide Child Parameters
namestringrequired
schema_registryobjectrequired

The plugin-global schema registry configuration.

Hide Child Parameters
confluentobject
Show Child Parameters
consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:grpcgrpcshttphttpswswss

Default:grpc, grpcs, http, https, ws, wss

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!