1// AlterUserSCRAMCredentialsRequest, proposed in KIP-554 and introduced
2// with Kafka 2.7.0, alters or deletes user SCRAM credentials.
3//
4// This request was introduced as part of the overarching KIP-500 initiative,
5// which is to remove Zookeeper as a dependency.
6//
7// This request requires ALTER on CLUSTER.
8AlterUserSCRAMCredentialsRequest => key 51, max version 0, flexible v0+, admin
9 // The SCRAM credentials to remove.
10 Deletions: [=>]
11 // The user name to match for removal.
12 Name: string
13 // The mechanism for the user name to remove.
14 Mechanism: int8
15 // The SCRAM credentials to update or insert.
16 Upsertions: [=>]
17 // The user name to use.
18 Name: string
19 // The mechanism to use for creating, where 1 is SCRAM-SHA-256 and 2 is
20 // SCRAM-SHA-512.
21 Mechanism: int8
22 // The number of iterations to use. This must be more than the minimum for
23 // the mechanism and cannot be more than 16384.
24 Iterations: int32
25 // A random salt generated by the client.
26 Salt: bytes
27 // The salted password to use.
28 SaltedPassword: bytes
29
30// AlterUserSCRAMCredentialsResponse is a response for an
31// AlterUserSCRAMCredentialsRequest.
32AlterUserSCRAMCredentialsResponse =>
33 ThrottleMillis
34 // The results for deletions and upsertions.
35 Results: [=>]
36 // The name this result corresponds to.
37 User: string
38 // The user-level error code.
39 ErrorCode: int16
40 // The user-level error message, if any.
41 ErrorMessage: nullable-string
View as plain text