cmccabe commented on a change in pull request #9032:
URL: https://github.com/apache/kafka/pull/9032#discussion_r468871453
##########
File path: clients/src/main/java/org/apache/kafka/clients/admin/Admin.java
##########
@@ -1214,6 +1215,64 @@ default AlterClientQuotasResult
alterClientQuotas(Collection<ClientQuotaAlterati
*/
AlterClientQuotasResult
alterClientQuotas(Collection<ClientQuotaAlteration> entries,
AlterClientQuotasOptions options);
+ /**
+ * <p>Describe all SASL/SCRAM credentials.
+ *
+ * <p>This is a convenience method for {@link
#describeUserScramCredentials(List, DescribeUserScramCredentialsOptions)}
+ *
+ * @return The DescribeUserScramCredentialsResult.
+ */
+ default DescribeUserScramCredentialsResult describeUserScramCredentials() {
+ return describeUserScramCredentials(null, new
DescribeUserScramCredentialsOptions());
+ }
+
+ /**
+ * <p>Describe SASL/SCRAM credentials for the given users.
+ *
+ * <p>This is a convenience method for {@link
#describeUserScramCredentials(List, DescribeUserScramCredentialsOptions)}
+ *
+ * @param users the users for which credentials are to be described; all
users' credentials are described if null
+ * or empty. A user explicitly specified here that does not
have a SCRAM credential will not appear
+ * in the results.
Review comment:
I originally was thinking we could just omit them. But thinking about
it more, I think we should have an error code to be consistent with our other
APIs. We'll need a new error code like USER_NOT_FOUND. And we'll also need to
add a per-user error code-- something we don't currently have. But it
shouldn't be too hard to do.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
