Skip to content

Commit

Permalink
Update documentation and yml
Browse files Browse the repository at this point in the history
  • Loading branch information
TOUFIKIzakarya committed Aug 30, 2024
1 parent ac90a53 commit 31e6890
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions Packs/SekoiaXDR/Integrations/SekoiaXDR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ Command to retrieve the events from the search job "sekoia-xdr-execute-events-qu
### sekoia-xdr-search-events

***
Command to search and retrieve the events from an alert. This is a combination of 3 commands: jobquery-events, jobquery-events-status and jobquery-retrieve events.
Command to search and retrieve the events from an alert. This is a combination of 3 commands: sekoia-xdr-events-execute-query, sekoia-xdr-events-status-query and sekoia-xdr-events-results-query.

#### Base Command

Expand Down Expand Up @@ -393,7 +393,7 @@ Command to get the possible transitions of status on the alert.
### sekoia-xdr-get-cases-alert

***
Command to retrieve the cases related to an Alert from Sekoia XDR. If a case_id is given, returns the information about it.
Command to retrieve the cases related to an Alert from Sekoia XDR. If a case_id is given, returns the information about it, and if not it will give all cases in this alert.

#### Base Command

Expand Down Expand Up @@ -757,7 +757,7 @@ There is no context output for this command.
### get-mapping-fields

***
This command pulls the remote schema for the different incident types, and their associated incident fields, from the remote system.
This command pulls the remote schema for the different incident types, and their associated incident fields, from the remote system.

#### Base Command

Expand Down Expand Up @@ -823,7 +823,7 @@ Command that performs a HTTP request to Sekoia using the integration authenticat
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| method | Method to use with the http request (GET,POST,etc). Default is GET. | Required |
| url_sufix | The URL sufix after https://api.sekoia.io/v1, i.e. /sic/alerts/ or /asset-management/assets/. | Required |
| url_sufix | The URL suffix after https://api.sekoia.io, i.e. /v1/sic/alerts/ or /v1/asset-management/assets/. | Required |
| parameters | Query parameters, i.e. limit -> 10 , match['status_name'] -> Ongoing. | Optional |

#### Context Output
Expand Down
8 changes: 4 additions & 4 deletions Packs/SekoiaXDR/Integrations/SekoiaXDR/SekoiaXDR.yml
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ script:
outputs:
- contextPath: SekoiaXDR.Events.Results
description: The outputs are different for each event, they will be output inside SekoiaXDR.Events.Results.
description: "Command to search and retrieve the events from an alert. This is a combination of 3 commands: jobquery-events, jobquery-events-status and jobquery-retrieve events."
description: "Command to search and retrieve the events from an alert. This is a combination of 3 commands: sekoia-xdr-events-execute-query, sekoia-xdr-events-status-query and sekoia-xdr-events-results-query."
- name: sekoia-xdr-update-status-alert
arguments:
- name: id
Expand Down Expand Up @@ -885,7 +885,7 @@ script:
description: The unique identifier of the avatar of the subscriber.
- contextPath: SekoiaXDR.Cases.subscribers.type
description: The type of subscriber.
description: Command to retrieve the cases related to an Alert from Sekoia XDR. If a case_id is given, returns the information about it.
description: Command to retrieve the cases related to an Alert from Sekoia XDR. If a case_id is given, returns the information about it, and if not it will give all cases in this alert.
- name: sekoia-xdr-get-asset
arguments:
- name: asset_uuid
Expand Down Expand Up @@ -1149,7 +1149,7 @@ script:
description: Pushes local changes to the remote system.
- name: get-mapping-fields
arguments: []
description: This command pulls the remote schema for the different incident types, and their associated incident fields, from the remote system.
description: This command pulls the remote schema for the different incident types, and their associated incident fields, from the remote system.
- name: sekoia-xdr-remove-attribute-asset
arguments:
- name: asset_uuid
Expand All @@ -1176,7 +1176,7 @@ script:
defaultValue: GET
- name: url_sufix
required: true
description: "The URL sufix after https://api.sekoia.io/v1, i.e. /sic/alerts/ or /asset-management/assets/."
description: "The URL suffix after https://api.sekoia.io, i.e. /v1/sic/alerts/ or /v1/asset-management/assets/."
- name: parameters
description: Query parameters, i.e. limit -> 10 , match['status_name'] -> Ongoing.
type: keyValue
Expand Down

0 comments on commit 31e6890

Please sign in to comment.