1// DescribeUserSCRAMCredentialsRequest, proposed in KIP-554 and introduced
2// with Kafka 2.7.0, describes 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 DESCRIBE on CLUSTER.
8DescribeUserSCRAMCredentialsRequest => key 50, max version 0, flexible v0+
9 // The users to describe, or null to describe all.
10 Users: nullable[=>]
11 // The user name.
12 Name: string
13
14// DescribeUserSCRAMCredentialsResponse is a response for a
15// DescribeUserSCRAMCredentialsRequest.
16DescribeUserSCRAMCredentialsResponse =>
17 ThrottleMillis
18 // The request-level error code. This is 0 except for auth or infra issues.
19 //
20 // CLUSTER_AUTHORIZATION_FAILED if you do not have DESCRIBE on CLUSTER.
21 ErrorCode: int16
22 // The request-level error message, if any.
23 ErrorMessage: nullable-string
24 // Results for descriptions, one per user.
25 Results: [=>]
26 // The name this result corresponds to.
27 User: string
28 // The user-level error code.
29 //
30 // RESOURCE_NOT_FOUND if the user does not exist or has no credentials.
31 //
32 // DUPLICATE_RESOURCE if the user is requested twice+.
33 ErrorCode: int16
34 // The user-level error message, if any.
35 ErrorMessage: nullable-string
36 // Information about the SCRAM credentials for this user.
37 CredentialInfos: [=>]
38 // The SCRAM mechanism for this user, where 0 is UNKNOWN, 1 is SCRAM-SHA-256,
39 // and 2 is SCRAM-SHA-512.
40 Mechanism: int8
41 // The number of iterations used in the SCRAM credential.
42 Iterations: int32
View as plain text