crowdstrike.falcon.case module – Manage Falcon cases
Note
This module is part of the crowdstrike.falcon collection (version 4.15.0).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install crowdstrike.falcon.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: crowdstrike.falcon.case.
New in crowdstrike.falcon 4.15.0
Synopsis
Create and update Falcon cases.
The same task creates the case when it is missing and updates it when it is different.
The API cannot delete a case. To end the work on a case, set status=closed.
Closing a case does not change the alerts in it. Use the alerts API to close them.
Requirements
The below requirements are needed on the host that executes this module.
Cases [READ, WRITE] API scope
CrowdStrike FalconPy >= 1.5.5
crowdstrike-falconpy >= 1.5.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
The composite IDs of the alerts to add to the case as evidence. The module only adds alerts. It does not remove an alert that is not in this list. |
|
The UUID of the user that the case is assigned to. An empty string removes the assignee. |
|
The registered result of the crowdstrike.falcon.auth module, or a dictionary containing the access_token and cloud keys. If provided, the client_id, client_secret, member_cid, and cloud options are ignored. Useful when needing to make multiple API calls to avoid rate limiting issues. |
|
The OAuth2 access token to use for authentication. |
|
The CrowdStrike cloud region to use. This can differ from the module’s cloud argument due to autodiscovery. |
|
The CrowdStrike API client ID to use. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike API secret that corresponds to the client ID. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike cloud region to use. All clouds are automatically discovered if not specified, except for the The Choices:
|
|
The description of the case. An empty string clears the description. |
|
Extended headers that are prepended to the default headers dictionary. |
|
The ID of the case to update. The module fails when no case has this ID. With id, name is the new name of the case. |
|
The CrowdStrike member CID for MSSP authentication. See the Falcon documentation for more information about API clients. The |
|
The name of the case. Required to create a case. With no id, the module finds the case by this exact, case-sensitive name. It creates the case when no case has this name, and updates it when one case has it. It fails when more than one case has this name; give id in that case. For a name with a single quote or a backslash, the module searches with the part of the name before that character, then compares the full names. It fails when the name starts with one of these characters; give id in that case. The name search does not see a new case for about 20 seconds. A later task in the same play that changes this case should use the id from the |
|
Remove the tags of the case that are not in tags. With purge_tags=true and no tags, the module does not change the tags. Choices:
|
|
The severity of the case, from 1 to 100. Required to create a case. |
|
The status of the case. A new case has the status Choices:
|
|
The tags of the case. Tags are case sensitive. The module adds the tags that the case does not have. With purge_tags=true, the module also removes the tags that are not in this list. |
|
Custom User-Agent string to use for requests to the API. The user agent string is prepended to the default user agent string ( See RFC 7231 for more information. The |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platforms: all |
Target OS/families that can be operated against |
See Also
See also
- crowdstrike.falcon.case_info
Get information about Falcon cases.
- crowdstrike.falcon.host_contain
Contain or lift containment on Falcon hosts.
- Case Management API reference
The CrowdStrike API operations that this module uses.
Examples
- name: Create a case with an alert as evidence
crowdstrike.falcon.case:
name: "Phishing investigation"
description: "Investigate the phishing alerts of the finance team"
severity: 50
tags:
- phishing
alerts:
- "0123456789abcdef0123456789abcdef:ind:fedcba9876543210fedcba9876543210-123456789012345"
register: new_case
- name: Set the status to in_progress and add tags, by ID
crowdstrike.falcon.case:
id: "{{ new_case.case.id }}"
status: in_progress
tags:
- finance
- name: Assign the case to a user
crowdstrike.falcon.case:
id: "{{ new_case.case.id }}"
assigned_to_user_uuid: "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"
- name: Remove the assignee of the case
crowdstrike.falcon.case:
id: "{{ new_case.case.id }}"
assigned_to_user_uuid: ""
- name: Close the case
crowdstrike.falcon.case:
id: "{{ new_case.case.id }}"
status: closed
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The case after the change, read again from the API. In check mode, the current case, or the wanted values with no Returned: success |
|
The analysis results of the case, by type. Each type has a list of Returned: success |
|
The user that the case is assigned to. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The user groups that the case is assigned to. Returned: success |
|
The customer ID that the case belongs to. Returned: success Sample: |
|
The consistency data of the case. Returned: success |
|
Whether the case data is consistent. Returned: success Sample: |
|
The consistency version of the case. Returned: success Sample: |
|
The user that created the case. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The time when the case was created. Returned: success Sample: |
|
The actor that created the case. Returned: success |
|
The type of the actor. Returned: success Sample: |
|
The description of the case. Returned: success Sample: |
|
The time when the case was closed. Returned: success Sample: |
|
The evidence of the case, by type. Each type has a list of Returned: success |
|
The ID of the case. Returned: success Sample: |
|
The user that last updated the case. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The name of the case. Returned: success Sample: |
|
The read-only state of the case. Returned: success |
|
Whether the case is read only. Returned: success Sample: |
|
The reference ID of the case. Returned: success Sample: |
|
The severity of the case. Returned: success Sample: |
|
The severity details of the case. Returned: success |
|
The severity level of the case. Returned: success Sample: |
|
The start time of the case. Returned: success |
|
The status of the case. Returned: success Sample: |
|
The tags of the case. Returned: success Sample: |
|
The actor that last updated the case. Returned: success |
|
The type of the actor. Returned: success Sample: |
|
The time when the case was last updated. Returned: success Sample: |
|
The version of the case. Returned: success Sample: |