Authentication API

This page describes how to authentication against Lenses APIs.

All requests must be authenticated using an HTTP Header x-kafka-lenses-token:myToken. You can obtain the token via the following login API or you can use a service account.

All REST APIs are protected via role-based authentication that is either BASIC or LDAP based, depending on how Lenses security has been set up. In order to be able to use the APIs, you will need to first authenticate via an appropriate user, then receive an access token and use that token for any subsequent request.

POST/api/login

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
user	string	Name of the user
password	string	Password of the user

Response

200

"a1f44cb8-0f37-4b96-828c-57bbd8d4934b"

401

UNAUTHORIZED

To run the example below, we recommend installing the jq tool

Example Request

 # login and receive the access token
HOST="http://localhost:3030"
curl -X POST -H "Content-Type:application/json" \
-d '{"user":"admin",  "password":"admin"}' \
${HOST}/api/login -s --compressed -w '\n'

Example Response

"a1f44cb8-0f37-4b96-828c-57bbd8d4934b"