-
Notifications
You must be signed in to change notification settings - Fork 252
[Docs][SIEM] Cases UI docs #967
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
Merged
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
77a1ec4
intial case api docs
1e04f31
starts updating the api
58ea8d6
updates patch comments
4b99ecd
api updates
ca573a2
starts conf api
11cc9f4
more conf api stuff
046e8c4
minor fixes
78aa326
more updates
539826d
proofing
4b12ec1
typo
22d6ef6
formatting
6495572
gets rid of me
fe197cd
adds delete all comments method
8369de8
corrections after feedback
3ba5ec6
corrections 2
7635681
corrections continued
419f4e2
cmore corrections
e5b4f5f
and more corrections
2fe7d75
even more
200bac5
rebase
35e7476
adds reporters to find
d63c3e4
corrections
a3ddac9
corrections II
356da9d
connector corrections
c3d9e80
final corrections
fa8d406
starts cases ui
3146aef
image and stuff
44a656b
open and manage cases
3ca79df
connectors
5cdbe7b
proofing and ui overview
ebf3133
starts corrections
7e80bce
corrections
c7b0d4d
more corrections
e06743a
sorted
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,65 @@ | ||
| [[cases-overview]] | ||
| [role="xpack"] | ||
|
|
||
| = Cases | ||
| = Cases (Beta) | ||
|
|
||
| // Placeholder | ||
| beta[] | ||
|
|
||
| Cases are used to open and track security issues directly in the {siem-app}. | ||
| They list the original reporter and all users who contribute to a case | ||
| (`participants`). Comments support markdown syntax, and allow linking to saved | ||
| <<timelines-overview, Timelines>>. Additionally, you can send cases to external | ||
| systems from within the {siem-app} (currently {sn}). <<cases-ui-integrations>> | ||
| describes how to set this up. | ||
|
|
||
| You can create and manage cases via the UI or the <<cases-api-overview>>. | ||
|
|
||
| IMPORTANT: To make sure you can view and open cases, see <<case-permisions>>. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-ui-home.png[] | ||
|
|
||
| [float] | ||
| [[cases-ui-open]] | ||
| == Open a new case | ||
|
|
||
| Open a new case to keep track of security issues and share their details with colleagues. | ||
|
|
||
| . Go to *SIEM* -> *Cases* -> *Create new case*. | ||
| . Give the case a name, and add a description and any relevant tags. | ||
| + | ||
| TIP: In the `Description` area, you can use | ||
| https://www.markdownguide.org/cheat-sheet[markdown] syntax and insert a | ||
| timeline link (click the icon in the top right corner of the area). | ||
|
|
||
| . When ready, create the case. | ||
| . If external connections are configured, you can send the case to {sn}. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-ui-open.png[] | ||
|
|
||
| [float] | ||
| [[cases-ui-manage]] | ||
| == Manage existing cases | ||
|
|
||
| You can search existing cases, and filter them by tags, reporter, and status | ||
| (open or closed). | ||
|
|
||
| To view a case, click on its name. You can then: | ||
|
|
||
| * Add a new comment. | ||
| * Edit existing comments and the case's description. | ||
| * Send updates to {sn} (if external connections are configured). | ||
| * Close the case. | ||
| * Reopen a closed case. | ||
| * Edit tags. | ||
| * Refresh cases to retrieve the latest updates. | ||
|
|
||
| [float] | ||
| [[case-permisions]] | ||
| == Cases prerequisites | ||
|
|
||
| To view cases, you need the {kib} space `Read` privilege for the Saved Objects | ||
| Management feature. To create cases and add comments, you need the `All` {kib} | ||
| space privilege for the Saved Objects Management feature. For more information, | ||
| see {kibana-ref}/xpack-spaces.html#spaces-control-user-access[Feature access based on user privileges]. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| [[cases-ui-integrations]] | ||
| [role="xpack"] | ||
| == Configuring external connections | ||
|
|
||
| You can push new cases and case updates to {sn}. To do this, you need to create | ||
| a connector, which stores the information required to push cases to {sn} via | ||
| {sn}'s https://developer.servicenow.com/dev.do#!/reference/api/madrid/rest/c_TableAPI[Table API]. | ||
| After you have created a connector, you can set {siem-soln} cases to close | ||
| automatically when they are sent to {sn}. | ||
|
|
||
| [float] | ||
| === Create a new connector | ||
|
|
||
| . Go to *SIEM* -> *Cases* -> *Edit external connection*. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/cases-ui-connector.png[] | ||
| . Click `Add new connector option`, and then click {sn}. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/cases-ui-sn-connector.png[] | ||
| . Fill in the following: | ||
| * _Connector name_: A name for the connector. | ||
| * _URL_: The URL of the {sn} instance to which you want to send cases. | ||
| * _Username_: The username of the {sn} account used to access the {sn} | ||
| instance. | ||
| * _Password_: The password of the the {sn} account used to access the {sn} | ||
| instance. | ||
| . To represent a SIEM case as a {sn} incident, these SIEM case fields are | ||
| mapped to {sn} incidents fields as follows: | ||
| ** `Title`: Mapped to the {sn} `Short description` field. When an update to a | ||
| SIEM case title is sent to {sn}, the existing {sn} `Short description` field is | ||
| overwritten. | ||
| ** `Description`: Mapped to the {sn} `Description` field. When an update to a | ||
| SIEM case description is sent to {sn}, the existing {sn} `Description` field is | ||
| overwritten. | ||
| ** `Comments`: Mapped to the {sn} `Comments` field. When a comment is updated | ||
| in a SIEM case, a new comment is added to the {sn} incident. | ||
| . Save the connector. | ||
|
|
||
| [float] | ||
| === Close sent cases automatically | ||
|
|
||
| To close cases when they are sent to {sn}, select the | ||
| _Automatically close SIEM cases when pushing new incident to third-party_ | ||
| option. | ||
|
|
||
| [float] | ||
| === Change and update connectors | ||
|
|
||
| You can create additional connectors, update existing connectors, and change | ||
| the connector used to send cases to {sn}. | ||
|
|
||
| . To change the connector used to send cases to {sn}: | ||
| .. Go to *SIEM* -> *Cases* -> *Edit external connection*. | ||
| .. Select the required connector from the `Incident management system` list. | ||
| . To update an existing connector: | ||
| .. Click `Update connector`. | ||
| .. Update the the connector fields as required. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.