DescribeUserScramCredentials
This page encodes the smallest legal instance of the request and the response: numeric fields are zero, strings and byte arrays are empty, every array carries exactly one sample element, and any records field holds one empty 61-byte RecordBatch v2. Version 0 is a flexible version, so every struct is terminated by a uvarint tagged-field count and strings and arrays carry compact length-plus-one prefixes. Sizes below include the leading int32 size prefix.
- API key
- 50
- Encoded at
- v0
- Flexible versions
- 0+
- Headers
- req v2, resp v1
- Request versions
- 0
- Response versions
- 0
- Request size
- 19 bytes
- Response size
- 30 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
DescribeUserScramCredentialsRequest v0, request header v2, 19 bytes on the wire
byte layout (19 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
object tree
DescribeUserScramCredentialsRequest message v0 [0x0000, 19B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 15 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 50 (DescribeUserScramCredentials) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 0 [0x0006, 2B] version of the API being invoked | +-- correlation_id int32 = 0 [0x0008, 4B] echoed back by the broker in the response | +-- client_id nullable_string = "" (int16 len=0) [0x000c, 2B] always a non-flexible int16-prefixed string | +-- tagged_fields uvarint = 0 [0x000e, 1B] number of tagged fields in the header +-- DescribeUserScramCredentialsRequest struct [0x000f, 4B] message body, version 0 +-- Users []UserName = 1 element [0x000f, 3B] The users to describe, or null/empty to describe all users. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- UserName[0] UserName = struct [0x0010, 2B] | +-- Name string = "" (compact, len+1=1) [0x0010, 1B] The user name. | +-- tagged_fields uvarint = 0 [0x0011, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0012, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 50, "type": "request", "listeners": ["broker", "controller"], "name": "DescribeUserScramCredentialsRequest", "validVersions": "0", "flexibleVersions": "0+", "fields": [ { "name": "Users", "type": "[]UserName", "versions": "0+", "nullableVersions": "0+", "about": "The users to describe, or null/empty to describe all users.", "fields": [ { "name": "Name", "type": "string", "versions": "0+", "about": "The user name." } ]} ] }
Response
DescribeUserScramCredentialsResponse v0, response header v1, 30 bytes on the wire
byte layout (30 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
object tree
DescribeUserScramCredentialsResponse message v0 [0x0000, 30B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 26 [0x0000, 4B] number of bytes that follow, patched after encoding +-- ResponseHeader v1 [0x0004, 5B] common response header | +-- correlation_id int32 = 0 [0x0004, 4B] matches the correlation_id of the request | +-- tagged_fields uvarint = 0 [0x0008, 1B] number of tagged fields in the header +-- DescribeUserScramCredentialsResponse struct [0x0009, 21B] message body, version 0 +-- ThrottleTimeMs int32 = 0 [0x0009, 4B] The duration in milliseconds for which the request was throttled due to a q... +-- ErrorCode int16 = 0 [0x000d, 2B] The message-level error code, 0 except for user authorization or infrastruc... +-- ErrorMessage string = "" (compact, len+1=1) [0x000f, 1B] The message-level error message, if any. +-- Results []DescribeUserScramCredentialsResult = 1 element [0x0010, 13B] The results for descriptions, one per user. | +-- length uvarint = 2 (compact, n+1) [0x0010, 1B] one sample element follows | +-- DescribeUserScramCredentialsResult[0] DescribeUserScramCredentialsResult = struct [0x0011, 12B] | +-- User string = "" (compact, len+1=1) [0x0011, 1B] The user name. | +-- ErrorCode int16 = 0 [0x0012, 2B] The user-level error code. | +-- ErrorMessage string = "" (compact, len+1=1) [0x0014, 1B] The user-level error message, if any. | +-- CredentialInfos []CredentialInfo = 1 element [0x0015, 7B] The mechanism and related information associated with the user's SCRAM cred... | | +-- length uvarint = 2 (compact, n+1) [0x0015, 1B] one sample element follows | | +-- CredentialInfo[0] CredentialInfo = struct [0x0016, 6B] | | +-- Mechanism int8 = 0 [0x0016, 1B] The SCRAM mechanism. | | +-- Iterations int32 = 0 [0x0017, 4B] The number of iterations used in the SCRAM credential. | | +-- tagged_fields uvarint = 0 [0x001b, 1B] number of tagged fields in this struct | +-- tagged_fields uvarint = 0 [0x001c, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x001d, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 50, "type": "response", "name": "DescribeUserScramCredentialsResponse", "validVersions": "0", "flexibleVersions": "0+", "fields": [ { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+", "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." }, { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The message-level error code, 0 except for user authorization or infrastructure issues." }, { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The message-level error message, if any." }, { "name": "Results", "type": "[]DescribeUserScramCredentialsResult", "versions": "0+", "about": "The results for descriptions, one per user.", "fields": [ { "name": "User", "type": "string", "versions": "0+", "about": "The user name." }, { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The user-level error code." }, { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "about": "The user-level error message, if any." }, { "name": "CredentialInfos", "type": "[]CredentialInfo", "versions": "0+", "about": "The mechanism and related information associated with the user's SCRAM credentials.", "fields": [ { "name": "Mechanism", "type": "int8", "versions": "0+", "about": "The SCRAM mechanism." }, { "name": "Iterations", "type": "int32", "versions": "0+", "about": "The number of iterations used in the SCRAM credential." }]} ]} ] }