Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Actions] Connector with secrets should have a UI notifier for the user, that it is a secret field. #78476

Closed
YulNaumenko opened this issue Sep 24, 2020 · 10 comments · Fixed by #80657
Assignees
Labels
Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@YulNaumenko
Copy link
Contributor

YulNaumenko commented Sep 24, 2020

When user edit a connector that has secrets, it's not clear that the secrets aren't returned in the edit form. This could cause confusion for support when they send a screenshot of the form with some fields missing.
It would be very helpful UX to have some notifier that the field is secret. (cc @mdefazio , @gchaps )

@YulNaumenko YulNaumenko added Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Sep 24, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@gchaps
Copy link
Contributor

gchaps commented Sep 28, 2020

@mdefazio Talked with @YulNaumenko. What's the best way to add text like this to the UI?

Fields are empty because values are encrypted.
Fill encrypted fields with a value.

@mdefazio
Copy link
Contributor

My first thought is have it be the validation help text that appears below the input (similar to the error messages). Sounds like we want some other visual indicator though on those inputs? Something that makes it clear that values are hidden as opposed to never there.

@YulNaumenko
Copy link
Contributor Author

@mdefazio the problem with the validation text is that it appears only after input field will loose the focus (event), but when you've just opened an Edit form you don't understand why this fields are empty. I like the text which @gchaps was proposed above, but I not sure how to better place it - maybe highlight the fields are with a splitter line and add this text above.

@mikecote mikecote added this to To-Do (Ordered by priority) in Make it Action Sep 29, 2020
@mdefazio
Copy link
Contributor

After our discussion, I think it makes sense to have the authentication portion of the connector form as a separate section. This gives us room to give more context around these specific fields.

If we add an 'Authentication' section (perhaps a better name?), then the description below that could prompt the user that in the future they will need to re-enter this. Then if they edit the connector (3rd screen), we change that to a callout so it's very visible. Perhaps we can tweak the description copy so we don't have to replace it, or maybe that's changed instead of using a callout, but I think this is getting clearer now.

@gchaps , I changed the text of the switch from what we had previously. I thought in this layout, the usage of 'Add' didn't feel right—but maybe you think it still works—I just wanted to try a different direction.

You'll see I sectioned off a few other parts of the form. I understand if this is done separately, but thought it help structure the form better.

image

@mikecote mikecote mentioned this issue Sep 29, 2020
36 tasks
@gchaps
Copy link
Contributor

gchaps commented Sep 29, 2020

@mdefazio I like this direction. I think 'Authentication' is the right word. Here are some suggestions for text

Toggle
Require authentication for this server

Explanatory text for default view
For additional security, you're prompted to enter these credentials each time you change the connector.

Explanatory text for user edit form
For security reasons, please reenter your username and password.

@mdefazio
Copy link
Contributor

Here are the mockups updated with the copy:

Default view:
image

Turn off authentication
image

Editing connector with authentication
image

@mikecote mikecote moved this from To-Do (Ordered by priority) to In Progress in Make it Action Sep 30, 2020
@mikecote mikecote self-assigned this Sep 30, 2020
@mikecote
Copy link
Contributor

@mdefazio Looks good! I wanted to provide a list of other connectors that also have fields that aren't returned on edit. Let me know if the proposed design works for those as well. I can work with @gchaps on the copy for each.

NOTE: All the fields below (minus webhook) are required on edit. For some reason in webhook you can click the username field, blur out of focus and the save button is then enabled.

IBM Resilient

Screen Shot 2020-09-30 at 9 06 32 AM

Jira

Screen Shot 2020-09-30 at 9 07 56 AM

PagerDuty

Screen Shot 2020-09-30 at 9 08 50 AM

ServiceNow

Screen Shot 2020-09-30 at 9 09 57 AM

Slack

Screen Shot 2020-09-30 at 9 10 42 AM

Webhook

Screen Shot 2020-09-30 at 9 12 19 AM

@mdefazio
Copy link
Contributor

After discussing further with Mike, I think it's clear that in some of these cases, not maintaining these values is not ideal UX. But for the time, let's add in a section heading and description text like we did with Email (perhaps it needs to be called something different for different connectors: 'Account information', etc).

The last edit that would be nice would be to move the links for 'Create Slack webhook URL' and 'Configure a PagerDuty account' and others to come after the heading + description text we are adding in (with an external link icon).

@gchaps
Copy link
Contributor

gchaps commented Sep 30, 2020

Discussed text with @mikecote and came up with this text.

Edit flow

API key

API key and ID are encrypted. Please reenter values for these fields.

JIRA

Authentication

Authentication credentials are encrypted. Please reenter values for these fields.

PagerDuty

Add this between the label and the fields:

This key is encrypted. Please reenter a value for this field.

Email

Username and password are encrypted. Please reenter values for these fields.

ServiceNow

Username and password are encrypted. Please reenter values for these fields.

Slack

This URL is encrypted. Please reenter a value for this field.

Webhook

Authentication

Username and password are encrypted. Please reenter values for these fields.

Creation flow

Remember these values. You must reenter them each time you edit the connector.

Remember this value. You must reenter it each time you edit the connector.

@mikecote mikecote changed the title [Actions] Connector with secrets should has a UI notifier for the user, that it is a secret field. [Actions] Connector with secrets should have a UI notifier for the user, that it is a secret field. Oct 1, 2020
@mikecote mikecote moved this from In Progress to In Review in Make it Action Oct 15, 2020
Make it Action automation moved this from In Review to Done (Ordered by most recent) Oct 21, 2020
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
No open projects
Make it Action
  
Done (Ordered by most recent)
Development

Successfully merging a pull request may close this issue.

6 participants