Instaclustr Logo
Powered by Redocly

Apache Kafka User

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
[
  • {
    }
]
List all active certificate of a given kafka user.
Retrieve a list of client certificates of a given kafka user.


SecurityBasic Authentication 
Request 
path Parameters
kafkaUserId
required
string <string> 
ID of the Kafka user which formed by combining ClusterId and Kafka username (ClusterID_Username).


 
Responses 
200
Successfully retrieved user's certificates.


get/cluster-management/v2/data-sources/kafka_users/{kafkaUserId}/certificates/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Renew a Kafka user's certificate
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
certificateId
required
string <string> 
ID of the certificate.


 
Responses 
202
Successfully renew the Kafka user's certificate


post/cluster-management/v2/operations/applications/kafka/user-certificates/renew/v2
Request samples 
application/json
{
  • "certificateId": "string"
}
Response samples 
application/json
{
  • "clusterId": "Id of the kafka cluster",
  • "csr": "generated csr string",
  • "kafkaUsername": "kafka username",
  • "validPeriod": 120
}
Download a Kafka user's certificate
SecurityBasic Authentication 
Request 
path Parameters
certificateId
required
string
ID of the Certificate.


 
Responses 
200
Successfully renew the Kafka user's certificate


get/cluster-management/v2/operations/applications/kafka/user-certificates/{certificateId}/download/v2
Request samples 
Create Kafka user's client certificate
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
csr
required
string <string> 
Certificate signing request.


 
kafkaUsername
required
string
The Kafka username


 
clusterId
required
string
ID of the kafka cluster


 
validPeriod
required
integer  [ 3 .. 120 ] 
Number of months for which the certificate will be valid.


 
Responses 
202
Kafka user's client certificate provisioning requested.


post/cluster-management/v2/resources/applications/kafka/user-certificates/v2
Request samples 
application/json
{
  • "clusterId": "Id of the kafka cluster",
  • "csr": "generated csr string",
  • "kafkaUsername": "kafka username",
  • "validPeriod": 120
}
Response samples 
application/json
{
  • "clusterId": "Id of the kafka cluster",
  • "csr": "generated csr string",
  • "kafkaUsername": "kafka username",
  • "validPeriod": 120
}
Get a Kafka user certificate
SecurityBasic Authentication 
Request 
path Parameters
certificateId
required
string
ID of the Certificate.


 
Responses 
200
Kafka user certificate retrieved.


get/cluster-management/v2/resources/applications/kafka/user-certificates/v2/{certificateId}
Request samples 
Response samples 
application/json
{
  • "clusterId": "Id of the kafka cluster",
  • "csr": "generated csr string",
  • "kafkaUsername": "kafka username",
  • "validPeriod": 120
}
Delete a Kafka user's certificate.
SecurityBasic Authentication 
Request 
path Parameters
certificateId
required
string
ID of the Certificate.


 
Responses 
204
Successfully processed the delete user's certificate.


delete/cluster-management/v2/resources/applications/kafka/user-certificates/v2/{certificateId}
Request samples 
Create a Kafka User.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
currentOperationStatus
string (CurrentOperationStatus) 
Indicates if the cluster is currently performing any operation such as being created, updated, or deleted


 Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"  
password
string <password> 
Password for the Kafka user.


 
saslScramMechanism
string (KafkaSaslScramMechanism) 
Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512


 
authMechanism
required
string (KafkaAuthMechanismsEnumV2) 
Authentication mechanisms supported for KafkaClusters.


 Enum: "MTLS" "SASL"  
clusterId
required
string <uuid> 
ID of the Kafka cluster.


 
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/v5
Request samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Get Kafka User details.
SecurityBasic Authentication 
Request 
path Parameters
kafkaUserId
required
string
ID of the Kafka user which formed by combining ClusterId and Kafka username (ClusterID_Username).


 
Responses 
200
Kafka user details retrieved.


get/cluster-management/v2/resources/applications/kafka/users/v5/{kafkaUserId}
Request samples 
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Update Kafka Authentication Details
SecurityBasic Authentication 
Request 
path Parameters
kafkaUserId
required
string
ID of the Kafka user which formed by combining ClusterId and Kafka username (ClusterID_Username).


 
Request Body schema: application/json
required
currentOperationStatus
string (CurrentOperationStatus) 
Indicates if the cluster is currently performing any operation such as being created, updated, or deleted


 Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"  
password
string <password> 
Password for the Kafka user.


 
saslScramMechanism
string (KafkaSaslScramMechanism) 
Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512


 
authMechanism
required
string (KafkaAuthMechanismsEnumV2) 
Authentication mechanisms supported for KafkaClusters.


 Enum: "MTLS" "SASL"  
clusterId
required
string <uuid> 
ID of the Kafka cluster.


 
username
required
string^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-...
Username of the Kafka user.


 
Responses 
202
Requested Kafka user update.


put/cluster-management/v2/resources/applications/kafka/users/v5/{kafkaUserId}
Request samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "overrideExistingUser": false,
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "overrideExistingUser": false,
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Delete a Kafka user
SecurityBasic Authentication 
Request 
path Parameters
kafkaUserId
required
string
ID of the Kafka user which formed by combining ClusterId and Kafka username (ClusterID_Username).


 
Responses 
204
Kafka user delete requested.


delete/cluster-management/v2/resources/applications/kafka/users/v5/{kafkaUserId}
Request samples 
➔ Next to Apache Zookeeper Provisioning V2