-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/elastic/kibana into alertin…
…g/ux-minimum-rule-interval-2
- Loading branch information
Showing
99 changed files
with
2,262 additions
and
983 deletions.
There are no files selected for viewing
This file contains 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,6 @@ | ||
steps: | ||
- command: .buildkite/scripts/steps/artifacts/build.sh | ||
label: Build Kibana Artifacts | ||
agents: | ||
queue: c2-16 | ||
timeout_in_minutes: 60 |
This file contains 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,11 @@ | ||
#!/usr/bin/env bash | ||
|
||
set -euo pipefail | ||
|
||
.buildkite/scripts/bootstrap.sh | ||
|
||
echo "--- Build Kibana Distribution" | ||
node scripts/build --all-platforms --debug --skip-docker-cloud | ||
|
||
echo "--- Build dependencies report" | ||
node scripts/licenses_csv_report --csv=target/dependencies_report.csv |
This file contains 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 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,193 @@ | ||
[[cases-api-find-cases]] | ||
== Find cases API | ||
++++ | ||
<titleabbrev>Find cases</titleabbrev> | ||
++++ | ||
|
||
Retrieves a paginated subset of cases. | ||
|
||
=== Request | ||
|
||
`GET <kibana host>:<port>/api/cases/_find` | ||
|
||
`GET <kibana host>:<port>/s/<space_id>/api/cases/_find` | ||
|
||
=== Prerequisite | ||
|
||
You must have `read` privileges for the *Cases* feature in the *Management*, | ||
*{observability}*, or *Security* section of the | ||
<<kibana-feature-privileges,{kib} feature privileges>>, depending on the | ||
`owner` of the cases you're seeking. | ||
|
||
=== Path parameters | ||
|
||
`<space_id>`:: | ||
(Optional, string) An identifier for the space. If it is not specified, the | ||
default space is used. | ||
|
||
=== Query parameters | ||
|
||
`defaultSearchOperator`:: | ||
(Optional, string) The default operator to use for the `simple_query_string`. | ||
Defaults to `OR`. | ||
|
||
//// | ||
`fields`:: | ||
(Optional, array of strings) The fields in the entity to return in the response. | ||
//// | ||
`owner`:: | ||
(Optional, string or array of strings) A filter to limit the retrieved cases to | ||
a specific set of applications. Valid values are: `cases`, `observability`, | ||
and `securitySolution`. If this parameter is omitted, the response contains all | ||
cases that the user has access to read. | ||
|
||
`page`:: | ||
(Optional, integer) The page number to return. Defaults to `1`. | ||
|
||
`perPage`:: | ||
(Optional, integer) The number of rules to return per page. Defaults to `20`. | ||
|
||
`reporters`:: | ||
(Optional, string or array of strings) Filters the returned cases by the | ||
reporter's `username`. | ||
|
||
`search`:: | ||
(Optional, string) An {es} | ||
{ref}/query-dsl-simple-query-string-query.html[simple_query_string] query that | ||
filters the objects in the response. | ||
|
||
`searchFields`:: | ||
(Optional, string or array of strings) The fields to perform the | ||
`simple_query_string` parsed query against. | ||
|
||
`sortField`:: | ||
(Optional, string) Determines which field is used to sort the results, | ||
`createdAt` or `updatedAt`. Defaults to `createdAt`. | ||
+ | ||
NOTE: Even though the JSON case object uses `created_at` and `updated_at` | ||
fields, you must use `createdAt` and `updatedAt` fields in the URL | ||
query. | ||
|
||
`sortOrder`:: | ||
(Optional, string) Determines the sort order, which can be `desc` or `asc`. | ||
Defaults to `desc`. | ||
|
||
`status`:: | ||
(Optional, string) Filters the returned cases by state, which can be `open`, | ||
`in-progress`, or `closed`. | ||
|
||
`tags`:: | ||
(Optional, string or array of strings) Filters the returned cases by tags. | ||
|
||
=== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
=== Example | ||
|
||
Retrieve the first five cases with the `phishing` tag, in ascending order by | ||
last update time: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
GET api/cases/_find?page=1&perPage=5&sortField=updatedAt&sortOrder=asc&tags=phishing | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
The API returns a JSON object listing the retrieved cases. For example: | ||
|
||
[source,json] | ||
-------------------------------------------------- | ||
{ | ||
"page": 1, | ||
"per_page": 5, | ||
"total": 2, | ||
"cases": [ | ||
{ | ||
"id": "abed3a70-71bd-11ea-a0b2-c51ea50a58e2", | ||
"version": "WzExMCwxXQ==", | ||
"comments": [], | ||
"totalComment": 0, | ||
"totalAlerts": 0, | ||
"title": "The Long Game", | ||
"tags": [ | ||
"windows", | ||
"phishing" | ||
], | ||
"description": "Windows 95", | ||
"settings": { | ||
"syncAlerts": true | ||
}, | ||
"owner": "securitySolution", | ||
"closed_at": null, | ||
"closed_by": null, | ||
"created_at": "2022-03-29T13:03:23.533Z", | ||
"created_by": { | ||
"email": "rhustler@email.com", | ||
"full_name": "Rat Hustler", | ||
"username": "rhustler" | ||
}, | ||
"status": "open", | ||
"updated_at": null, | ||
"updated_by": null, | ||
"connector": { | ||
"id": "131d4448-abe0-4789-939d-8ef60680b498", | ||
"name": "My connector", | ||
"type": ".jira", | ||
"fields": { | ||
"issueType": "10006", | ||
"priority": null, | ||
} | ||
} | ||
"external_service": null, | ||
}, | ||
{ | ||
"id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2", | ||
"version": "Wzk4LDFd", | ||
"comments": [], | ||
"totalComment": 0, | ||
"totalAlerts": 0, | ||
"title": "This case will self-destruct in 5 seconds", | ||
"tags": [ | ||
"phishing", | ||
"social engineering", | ||
"bubblegum" | ||
], | ||
"description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active!", | ||
"settings": { | ||
"syncAlerts": false | ||
}, | ||
"owner": "cases", | ||
"closed_at": null, | ||
"closed_by": null, | ||
"created_at": "2022-03-29T11:30:02.658Z", | ||
"created_by": { | ||
"email": "ahunley@imf.usa.gov", | ||
"full_name": "Alan Hunley", | ||
"username": "ahunley" | ||
}, | ||
"status": "open", | ||
"updated_at": "2022-03-29T12:01:50.244Z", | ||
"updated_by": { | ||
"full_name": "Classified", | ||
"email": "classified@hms.oo.gov.uk", | ||
"username": "M" | ||
}, | ||
"connector": { | ||
"id": "131d4448-abe0-4789-939d-8ef60680b498", | ||
"name": "My connector", | ||
"type": ".resilient", | ||
"fields": { | ||
"issueTypes": [13], | ||
"severityCode": 6, | ||
} | ||
}, | ||
"external_service": null, | ||
} | ||
], | ||
"count_open_cases": 2, | ||
"count_in_progress_cases":0, | ||
"count_closed_cases": 0 | ||
} | ||
-------------------------------------------------- |
This file contains 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,60 @@ | ||
[[cases-api-find-connectors]] | ||
== Find connectors API | ||
++++ | ||
<titleabbrev>Find connectors</titleabbrev> | ||
++++ | ||
|
||
Retrieves information about <<action-types,connectors>>. | ||
|
||
In particular, only the connectors that are supported for use in cases are | ||
returned. Refer to the list of supported external incident management systems in | ||
<<add-case-connectors>>. | ||
|
||
=== Request | ||
|
||
`GET <kibana host>:<port>/api/cases/configure/connectors/_find` | ||
|
||
`GET <kibana host>:<port>/s/<space_id>/api/cases/configure/connectors/_find` | ||
|
||
=== Prerequisite | ||
|
||
You must have `read` privileges for the *Actions and Connectors* feature in the | ||
*Management* section of the | ||
<<kibana-feature-privileges,{kib} feature privileges>>. | ||
|
||
=== Path parameters | ||
|
||
`<space_id>`:: | ||
(Optional, string) An identifier for the space. If it is not specified, the | ||
default space is used. | ||
|
||
=== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
=== Example | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
GET api/cases/configure/connectors/_find | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
The API returns a JSON object describing the connectors and their settings: | ||
|
||
[source,json] | ||
-------------------------------------------------- | ||
[{ | ||
"id":"61787f53-4eee-4741-8df6-8fe84fa616f7", | ||
"actionTypeId": ".jira", | ||
"name":"my-Jira", | ||
"isMissingSecrets":false, | ||
"config": { | ||
"apiUrl":"https://elastic.atlassian.net/", | ||
"projectKey":"ES" | ||
}, | ||
"isPreconfigured":false, | ||
"referencedByCount":0 | ||
}] | ||
-------------------------------------------------- |
Binary file removed
BIN
-172 KB
docs/developer/advanced/images/sharing-saved-objects-dev-flowchart.png
Binary file not shown.
Binary file added
BIN
+171 KB
docs/developer/advanced/images/sharing-saved-objects-phase-1-dev-flowchart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+140 KB
docs/developer/advanced/images/sharing-saved-objects-phase-2-dev-flowchart.png
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.
Oops, something went wrong.