Authentication in Kafka

Applies to ReadyAPI 3.7, last modified on April 08, 2021

By default, ReadyAPI supports authentication to Kafka brokers and schema registries using the API key and client secret. In particular, this is a common way of authentication in Confluent.

In ReadyAPI, this process is implemented through the Basic authorization profile:

  1. Create a Basic authorization profile:

    Authentication to Kafka: Create authorization profile

    Click the image to enlarge it.

    Authentication to schema registry: Create authorization profile

    Click the image to enlarge it.

    Schema registry connection settings are only available when the JSON via Avro (Confluent) message format is selected.
  2. Enter credentials:

    • Username – The API key.
    • Password – The client secret.
    Authentication to Kafka: Enter API key and secret

    Click the image to enlarge it.

  3. Select the profile:

    Authentication to Kafka: Select profile
    Authentication to schema registry: Select profile

Other authentication methods

If your Kafka broker uses another authentication mechanism, you should add custom authentication parameters to the Connection Settings. For example, for the SASL/PLAIN authentication, you will need to use the sasl.mechanism=PLAIN and security.protocol=SASL_PLAINTEXT parameters:

Authentication to Kafka: Custom parameters

Click the image to enlarge it.

To learn which parameters you need for other authentication mechanisms, see the documentation of your Kafka provider.

Next Steps

See Also

AMQP Testing
Testing Internet of Things (IoT)

Highlight search results