gplazma: enhance help of explain login command

Make life of admins simpler. Acked-by: Paul Millar Acked-by: Lea Morschel Target: master Require-book: no Require-notes: no
dCache · Oct 30, 2023 · 6bd6580 · 6bd6580
1 parent 7ca86f0
commit 6bd6580
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/modules/dcache-gplazma/src/main/java/org/dcache/auth/Gplazma2LoginStrategy.java b/modules/dcache-gplazma/src/main/java/org/dcache/auth/Gplazma2LoginStrategy.java
@@ -241,9 +241,27 @@ public Set<Principal> reverseMap(Principal principal) throws CacheException {
           "This command runs a test login with the supplied principals\n" +
                 "The result is tracked and an explanation is provided of how \n" +
                 "the result was obtained.\n\n" +
+                "The principal format is:\n" +
+                "  <short hand identifier:value>\n" +
+                "or\n" +
+                "  <class name:value>\n\n" +
+                "The support short hand identifiers are:\n" +
+                " dn\n" +
+                " gid\n" +
+                " kerberos\n" +
+                " fqan\n" +
+                " name\n" +
+                " origin\n" +
+                " oidc\n" +
+                " email\n" +
+                " uid\n" +
+                " username\n" +
+                " group\n\n" +
+                "All other types can be specific full qualified class names.\n\n" +
                 "Examples:\n" +
                 "  explain login \"dn:/C=DE/O=GermanGrid/OU=DESY/CN=testUser\" fqan:/test\n" +
-                "  explain login username:testuser\n";
+                "  explain login username:testuser\n" +
+                "  explain login org.dcache.auth.LoginNamePrincipal:testuser\n\n";
     public static final String hh_explain_login = "<principal> [<principal> ...] # explain the result of login";
 
     public String ac_explain_login_$_1_99(Args args) {