Kafka User V2

List all Kafka users.

Retrieve a list of the kafka users existing in the given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the Kafka cluster.

Responses
200

Successfully retrieved Kafka users.

get/cluster-management/v2/data-sources/kafka_cluster/{clusterId}/users/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Create a Kafka User.

SecurityBasic Authentication
Request
Request Body schema: application/json
password
required
string <password>

Password for the Kafka user.

required
object (KafkaUserOptionsV2)

Initial options used when creating Kafka user

clusterId
required
string <uuid>

ID of the Kafka cluster.

initialPermissions
required
string

Permissions initially granted to Kafka user upon creation.

Enum: "standard" "read-only" "none"
username
required
string^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-...

Username of the Kafka user.

Responses
202

Kafka user provisioning requested.

post/cluster-management/v2/resources/applications/kafka/users/v2
Request samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "options": {
    },
  • "password": "myPassword1.",
  • "username": "myKafkaUser"
}
Response samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "options": {
    },
  • "password": "myPassword1.",
  • "username": "myKafkaUser"
}

Get Kafka User details.

SecurityBasic Authentication
Request
path Parameters
kafkaUserId
required
string

ID of the Kafka cluster.

Responses
200

Kafka user details retrieved.

get/cluster-management/v2/resources/applications/kafka/users/v2/{kafkaUserId}
Request samples
Response samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "options": {
    },
  • "password": "myPassword1.",
  • "username": "myKafkaUser"
}

Update Kafka user password

SecurityBasic Authentication
Request
path Parameters
kafkaUserId
required
string

ID of the Kafka cluster.

Request Body schema: application/json
password
required
string <password>

Password for the Kafka user.

required
object (KafkaUserOptionsV2)

Initial options used when creating Kafka user

clusterId
required
string <uuid>

ID of the Kafka cluster.

initialPermissions
required
string

Permissions initially granted to Kafka user upon creation.

Enum: "standard" "read-only" "none"
username
required
string^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-...

Username of the Kafka user.

Responses
200

Requested Kafka user update.

put/cluster-management/v2/resources/applications/kafka/users/v2/{kafkaUserId}
Request samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "options": {
    },
  • "password": "myPassword1.",
  • "username": "myKafkaUser"
}
Response samples
application/json
{
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "options": {
    },
  • "password": "myPassword1.",
  • "username": "myKafkaUser"
}

Delete a Kafka user

SecurityBasic Authentication
Request
path Parameters
kafkaUserId
required
string

ID of the Kafka cluster.

Responses
204

Kafka user delete requested.

delete/cluster-management/v2/resources/applications/kafka/users/v2/{kafkaUserId}
Request samples