View Source KlifeProtocol.Messages.DescribeUserScramCredentials (Klife Protocol v0.5.0)

Kafka protocol DescribeUserScramCredentials message

Request versions summary:

Response versions summary:

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: 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. (int32 | versions 0+)

  • error_code: The message-level error code, 0 except for user authorization or infrastructure issues. (int16 | versions 0+)

  • error_message: The message-level error message, if any. (string | versions 0+)

  • results: The results for descriptions, one per user. ([]DescribeUserScramCredentialsResult | versions 0+)

    • user: The user name. (string | versions 0+)

    • error_code: The user-level error code. (int16 | versions 0+)

    • error_message: The user-level error message, if any. (string | versions 0+)

    • credential_infos: The mechanism and related information associated with the user's SCRAM credentials. ([]CredentialInfo | versions 0+)

      • mechanism: The SCRAM mechanism. (int8 | versions 0+)

      • iterations: The number of iterations used in the SCRAM credential. (int32 | versions 0+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • users: The users to describe, or null/empty to describe all users. ([]UserName | versions 0+)

    • name: The user name. (string | versions 0+)