Instaclustr Logo
Powered by Redocly

Apache Kafka User

Create a Kafka User.

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

Password for the Kafka user.

authMechanism
string (KafkaAuthMechanismsEnumV2)

Authentication mechanisms supported for KafkaClusters.

Enum: "MTLS" "SASL"
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 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/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 and options
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
password
required
string <password> 
Password for the Kafka user.


 
authMechanism
string (KafkaAuthMechanismsEnumV2) 
Authentication mechanisms supported for KafkaClusters.


 Enum: "MTLS" "SASL"  
required
object (KafkaUserOptionsV2) 
Initial options used when creating Kafka user


 
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/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 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/v2/{kafkaUserId}
Request samples 
Create a Kafka User.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
password
string <password> 
Password for the Kafka user.


 
overrideExistingUser
boolean
Overwrite user if already exists.


 
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.


 
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/v3
Request samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "initialPermissions": "standard",
  • "overrideExistingUser": false,
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "initialPermissions": "standard",
  • "overrideExistingUser": false,
  • "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/v3/{kafkaUserId}
Request samples 
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "initialPermissions": "standard",
  • "overrideExistingUser": false,
  • "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
password
string <password> 
Password for the Kafka user.


 
overrideExistingUser
boolean
Overwrite user if already exists.


 
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/v3/{kafkaUserId}
Request samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_myKafkaUser",
  • "initialPermissions": "standard",
  • "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",
  • "initialPermissions": "standard",
  • "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/v3/{kafkaUserId}
Request samples 
Create a Kafka User.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
password
string <password> 
Password for the Kafka user.


 
overrideExistingUser
boolean
Overwrite user if already exists.


 
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/v4
Request samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "overrideExistingUser": false,
  • "password": "myPassword1.",
  • "saslScramMechanism": "SCRAM-SHA-256",
  • "username": "myKafkaUser"
}
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "overrideExistingUser": false,
  • "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/v4/{kafkaUserId}
Request samples 
Response samples 
application/json
{
  • "authMechanism": "SASL",
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "overrideExistingUser": false,
  • "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
password
string <password> 
Password for the Kafka user.


 
overrideExistingUser
boolean
Overwrite user if already exists.


 
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/v4/{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/v4/{kafkaUserId}
Request samples