Update Cortex Xpanse asm-list-external-websites command to include pa… #40140
Conversation
…gination support.
content-bot
added
Contribution
|
Thank you for your contribution. Your generosity and caring are unrivaled! Make sure to register your contribution by filling the Contribution Registration form, so our content wizard @itssapir will know the proposed changes are ready to be reviewed. |
content-bot
added
Community
Contribution Form Filled
|
@zdrouse , thank you for the submission. What were your thoughts on using this? With raw-response=true only? |
@johnnywilkes you are asking my thoughts on giving this command support for paging? We need to retrieve all of the external websites in Xpanse from XSOAR. Without paging support, we cannot do this. From there, a subplaybook or automation can be built to repeatedly call the command using the |
|
@zdrouse , I understand why you want paging support. However, I am not sure with your change how it is usable. The command doesn't seem to expose If not, please look into changes to add |
…r ExternalWebsiteReply that contains contextual information about the request for external websites.
|
@johnnywilkes I see. Yes, usually when I am using commands on playbook tasks I typically utilize extend-context with the raw response in order to see all the data or pick and choose what I want from the raw response. I find often that I cannot rely on the implemented outputs of the command results because it is either missing data or doesn't provide it in the format I need which I suppose is the point you are making. I've adjusted the output in the integration for this command to provide another node in context for this information. I had to adjust the |
|
Adding a screenshot of context adjustments for reference. |
|
Looks like we want to fit these standards: https://xsoar.pan.dev/docs/integrations/code-conventions#pagination-in-integration-commands |
|
@zdrouse , reaching out on DFIR slack |
|
Tests failing because context output change, reaching out on DFIR |
… since we are unable to change existing functionality of outputs_prefix of the original CommandResults. The new CommandResults object provides an additional about with context information about the request including next page token for pagination, the total results and the result count from the request. CommandResults is also using so that context is overwritten with the most recent command execution per recommended usage of .
|
@johnnywilkes updated to include an additional |
|
@zdrouse , seeing an issue, will message on slack |
|
seems to be underlying API issue that first response returns one less form limit: 
Token changes everytime
|
There was a problem hiding this comment.
For Packs/CortexXpanse/Integrations/CortexXpanse/CortexXpanse_test.py
returns from list_external_websites_command() are now a list so need to change
assert response.outputs == EXTERNAL_WEBSITES_RESULTS.get("ExternalWebsite", {}).get("websites")
assert response.outputs_prefix == "ASM.ExternalWebsite"
to
assert response[0].outputs == EXTERNAL_WEBSITES_RESULTS.get("ExternalWebsite", {}).get("websites")
assert response[0].outputs_prefix == "ASM.ExternalWebsite"
| @@ -1120,25 +1120,33 @@ def get_incident_command(client: Client, args: dict[str, Any]) -> CommandResults | |||
|
|
|||
| def list_external_websites_command(client: Client, args: Dict[str, Any]) -> CommandResults: | |||
There was a problem hiding this comment.
| def list_external_websites_command(client: Client, args: Dict[str, Any]) -> CommandResults: | |
| def list_external_websites_command(client: Client, args: Dict[str, Any]) -> list[CommandResults]: |
for type checking
|
|
||
| Args: | ||
| client (Client): CortexXpanse client to use. | ||
| args (dict): all command arguments, usually passed from ``demisto.args()``. | ||
| ``args['filter']`` Used for filter websites based on authentication type | ||
| ``args['limit']`` Used for limit num of results | ||
| ``args['use_page_token']`` Boolean value used to specify pagination | ||
| ``args['next_page_token']`` String value of a page token to get the next page of results | ||
|
|
||
| Returns: | ||
| CommandResults: A ``CommandResults`` object that is then passed to ``return_results`` |
There was a problem hiding this comment.
| CommandResults: A ``CommandResults`` object that is then passed to ``return_results`` | |
| CommandResults: A list of `CommandResults` objects that is then passed to ``return_results`` |
update description
…gination support.
Contributing to Cortex XSOAR Content
Make sure to register your contribution by filling the contribution registration form
The Pull Request will be reviewed only after the contribution registration form is filled.
Status
Related Issues
Currently, asm-list-external-websites can only ever retrieve the first 500 websites and organizations have way more than that.
Description
Update asm-list-external-websites command to allow for pagination of requests.
API Reference: https://docs-cortex.paloaltonetworks.com/r/Cortex-Xpanse-REST-API/Get-All-Websites
Must have