Kafka Configs Kafka Protocol Wire Format API Versions KIPs Errors Kafka Upgrade Config Advisor Flink SQL
conduktor.io ↗

Kafka AlterUserScramCredentials Request Wire Format v0 — Binary Protocol Layout

What is AlterUserScramCredentials?

Creates, updates, or removes SCRAM passwords via kafka-configs.sh --alter. Credentials are stored in ZooKeeper or KRaft metadata and take effect immediately without broker restart.

Wire Diagram

Request Header · flexible
message_size int32 · 4B
api_key int16 · 2B
api_version int16 · 2B
correlation_id int32 · 4B
client_id string (compact)
tagged var
AlterUserScramCredentialsRequest v0
Deletions array
Upsertions array
tagged var
Name string (compact)
Mechanism int8 · 1B
tagged var
Name string (compact)
Mechanism int8 · 1B
Iterations int32 · 4B
Salt bytes (compact)
SaltedPassword bytes (compact)
tagged var

Schema & Example

Schema
{
  "Deletions": [{
      "Name": string,
      "Mechanism": int8
  }],
  "Upsertions": [{
      "Name": string,
      "Mechanism": int8,
      "Iterations": int32,
      "Salt": bytes,
      "SaltedPassword": bytes
  }]
}
Example
{
  "Deletions": [{
      "Name": "orders",
      "Mechanism": "SCRAM-SHA-256"
  }],
  "Upsertions": [{
      "Name": "orders",
      "Mechanism": "SCRAM-SHA-256",
      "Iterations": 0,
      "Salt": "<binary>",
      "SaltedPassword": "<binary>"
  }]
}