authentik icon indicating copy to clipboard operation
authentik copied to clipboard

Comments, Notes, or Description fields.

Open dracon80 opened this issue 1 year ago • 3 comments

Is your feature request related to a problem? Please describe. I may be missing something obvious, but I have search the documentation and google. Is there a way to record a description or comments for custom flows or stages, maybe even policies that I have created? It would be helpful when going back to review a flow to know why I created it, and what its intent is.

Describe the solution you'd like It would be nice to have a comments or description field for any of the custom objects that can be created (e.g. policies, flows, stages). A simple text field that allows me to record why it exists and what it is supposed to do. It would make it easier for future me or others to troubleshoot any issues.

Describe alternatives you've considered A naming convention is the only solution I have come with, but it makes names long and doesn't allow for very detailed information.

dracon80 avatar Mar 20 '24 03:03 dracon80

There's some options for doing this on users and groups (and generally all objects that have an attributes field)

For other objects the current best solution is to use IAC and define objects in blueprints or terraform

BeryJu avatar Mar 20 '24 13:03 BeryJu

Isn't the attributes field used for filtering and policy assignments? I wouldn't have even considered putting something like this in the attributes field, or have I completely missed the mark on this one? I'll look into the blueprint option.

dracon80 avatar Mar 21 '24 21:03 dracon80

The attributes field can be used for that (and for the case of the user there are some reserved keys that function as settings) however they allow you to store any keg value data that's json serializable so they are also very much suitable for notes.

BeryJu avatar Mar 22 '24 00:03 BeryJu