Repository navigation
Improve Javadoc for executeActionsEmail REST endpoint to list all supported actions #41553
ChristopheGustave
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Hi maintainers,
I'd like to suggest a documentation enhancement to improve clarity around the usage of the executeActionsEmail endpoint in UserResource.java.
Currently, the Javadoc for this method outlines its purpose but does not specify the valid values that can be passed in the actions parameter. These values correspond to UserModel.RequiredAction, but this link isn't immediately clear to users unfamiliar with Keycloak's internal model.
As a result, developers may run into confusion or errors when trying to trigger specific user actions like resetting a password, configuring TOTP, or verifying email.
My proposal is to update the Javadoc for UserResource.executeActionsEmail() to:
Please let me know if this improvement would be welcome. I’d be happy to submit a PR with the proposed changes.
Thanks,
Christophe Gustave
All reactions