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

[SIEM] [Case] Service Now Kibana Action #53890

Merged
merged 18 commits into from
Jan 15, 2020

Conversation

stephmilovic
Copy link
Contributor

@stephmilovic stephmilovic commented Jan 2, 2020

Summary

Resolves #53891

Kibana action for posting new incidents to Service Now.

Testing instructions:

You will need an instance of ServiceNow. Either create your own, or @stephmilovic has an instance that falls asleep after 24 hours. Slack me if it has fallen asleep and I can wake it. The url and credentials for that instance are here.

  1. POST a new ServiceNow Kibana action with your credentials:
    POST http://localhost:5601/api/action
{
 "name": "name-your-servicenow-action",
 "actionTypeId": ".servicenow",
 "secrets": {
 	"username": "username",
 	"password": "password"
 },
 "config": {
 	"apiUrl": "https://your-service-now-url.com"
 }
}
  1. Use the id returned from your successful Kibana action POST to create a new service now incident.
    POST http://localhost:5601/api/action/123-the-kbn-action-id/_execute
{
    "params": {
        "short_description": "Test incident creation through Kibana actions",
        "comments": "These are my comments"
    }
}

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

For maintainers

@elasticmachine
Copy link
Contributor

Pinging @elastic/siem (Team:SIEM)

@stephmilovic
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Member

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thx!

I noted that since the url to ServiceNow is configurable, a FTS simulator endpoint for ServiceNow should be created, so we can add some FT tests. Feel free to create an issue to do that, not really required for the PR, but would be happy to see it. Note the newly created issue in this PR.

@pmuellr
Copy link
Member

pmuellr commented Jan 10, 2020

@stephmilovic did you want this merged for 7.6? (sorry, I prolly already asked but can't find it ATM). I'd like another reviewer, but the usual reviewers won't be available till just before FF. I could round up someone else tho, LMK.

Copy link
Contributor

@peterschretlen peterschretlen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just curious what you think about additional fields. If we don't need those, I think the server-side code is good to go.

It would be great if you could add this to the list of built-in types in actions/README.md with some docs on the parameters.

Do you intend to do the UI portion as well (as a separate PR, not here) ?

@stephmilovic
Copy link
Contributor Author

Looks great! Just curious what you think about additional fields. If we don't need those, I think the server-side code is good to go.

It would be great if you could add this to the list of built-in types in actions/README.md with some docs on the parameters.

Do you intend to do the UI portion as well (as a separate PR, not here) ?

@peterschretlen Thanks for the review! I am building out a Case Management workflow for SIEM, which will include third party integrations such as ServiceNow. As we are doing a little planning while developing, I only included the comments and short_description fields for this ServiceNow plugin as the product team hammers out which fields we sill actually use. I was going to come back to add these in a separate PR, unless you think I should just include all available fields as optional? My concern with that... if you look at what the ServiceNow incident JSON looks like (response on the right column), there are about 90 fields we can post. Would you want me to include all of those? SIEM will probably use 2-3 in the Case Management MVP. #50103

@peterschretlen
Copy link
Contributor

Discussed with @stephmilovic. It sounds like more incident fields will be taken into consideration later, but for the MVP only comments and short description are needed. We'll use the minimal set for now, add additional fields if/when needed.

Copy link
Contributor

@peterschretlen peterschretlen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@stephmilovic stephmilovic merged commit 5ba24b8 into elastic:master Jan 15, 2020
@stephmilovic stephmilovic deleted the servicenow-kibana-action branch January 15, 2020 20:50
stephmilovic added a commit to stephmilovic/kibana that referenced this pull request Jan 15, 2020
jkelastic pushed a commit to jkelastic/kibana that referenced this pull request Jan 17, 2020
@cnasikas
Copy link
Member

cnasikas commented Feb 21, 2020

Kibana's Actions Documentation moved here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SIEM] [Case] Kibana action for ServiceNow
6 participants