Retrieve a Kafka Cluster User

Retrieves a specific user associated with a Kafka cluster, including access certificates in the metadata.

Endpoint

GET /clusters/{clusterId}/users/{userId}/access

Description

The GET /clusters/{clusterId}/users/{userId}/access endpoint retrieves a specific user identified by userId from the Kafka cluster identified by clusterId. The response includes detailed metadata about the user, including creation and modification timestamps, ownership information, and current operational state. Access credentials such as certificateAuthority, privateKey, and certificate are also provided to facilitate secure communication with the Kafka cluster. Use this endpoint to manage and obtain detailed information about users' credentials within your Kafka infrastructure.

Parameters

• clusterId (string, path, required): The UUID of the Kafka cluster from which to retrieve the user.

  • Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/users/{userId}/access

• userId (string, path, required): The UUID of the user whose credentials and metadata are to be retrieved.

  • Example: d11db12c-2625-5664-afd4-a3599731b5af

Response

{
  "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",
    "message": "In progress.",
    "certificateAuthority": "-----BEGIN CERTIFICATE ...",
    "privateKey": "-----BEGIN PRIVATE KEY ...",
    "certificate": "-----BEGIN CERTIFICATE ..."
  },
  "properties": {
    "name": "my-kafka-cluster-user"
  }
}