Make get-api-key
name and output less ambiguous
#35
Labels
improvement
This issue or pull request will add or improve functionality, maintainability, or ease of use
💡 Summary
Currently, the
get-api-key
script will output one API key for every user in the Gophish database. At minimum, this script should be modified so that its name is changed toget-api-keys
and documented appropriately to make it clear that multiple keys may be returned.Two other solutions have been discussed:
admin
) would be used.If either of those solutions are implemented, it's important to conspicuously document the fact that this script will not work as intended if the default Gophish user is ever deleted.
Motivation and context
This was originally noted by @mcdonnnj in cisagov/pca-gophish-composition-packer#70 (review). That PR added a band-aid solution in response to the issues noted above.
Implementation notes
See options discussed in "Summary" section above.
Acceptance criteria
get-api-key
accurately reflects the full range of potential outputs (i.e. zero or more API keys).The text was updated successfully, but these errors were encountered: