List SCRAM credentials

GET

/api/v1/clusters/{id}/scram-users

const url = 'http://localhost:8080/api/v1/clusters/example/scram-users';
const options = {method: 'GET', headers: {cookie: 'brokerium_session=<brokerium_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/clusters/example/scram-users \
  --cookie brokerium_session=<brokerium_session>

Role: viewer.

Authorizations

sessionCookie
bearerToken

Parameters

Path Parameters

required

string

Responses

200

Users and their mechanisms (never passwords).

application/json

object

users

Array<object>

object

user

string

mechanisms

Array<object>

object

mechanism

string

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

iterations

integer format: int32

Example

{
  "users": [
    {
      "mechanisms": [
        {
          "mechanism": "SCRAM-SHA-256"
        }
      ]
    }
  ]
}

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.