List all Kafka Users

This endpoint allows you to retrieve all users associated with a specified Kafka cluster, supporting pagination and optional filters.

Endpoint

GET /clusters/{clusterId}/users

The GET /clusters/{clusterId}/users endpoint retrieves a collection of users associated with the Kafka cluster specified by clusterId. The response includes a paginated list of user objects, each containing metadata such as creation and modification details, ownership information, and current operational state. Use this endpoint to manage and monitor users efficiently within your Kafka cluster.

Request

curl -X 'GET' \
  'https://kafka.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $Token'

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Accept	yes	string	Set this to application/json.
Authorization	yes	string	Provide a header value as Bearer followed by your token.

Request Path Parameters

Response

200 Successful operation

{
  "id": "434e0c83-031d-5f5a-be82-63ee54dda025",
  "type": "collection",
  "href": "/clusters/{clusterId}/users",
  "items": [
    {
      "id": "d11db12c-2625-5664-afd4-a3599731b5af",
      "type": "user",
      "href": "/clusters/{clusterId}/users/d11db12c-2625-5664-afd4-a3599731b5af",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "admin"
      }
    }
  ]
}