|
| 1 | +--- |
| 2 | +title: CrowdStrike |
| 3 | +description: Query CrowdStrike Identity Protection sensors and documented aggregates |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="crowdstrike" |
| 10 | + color="#E01F3D" |
| 11 | +/> |
| 12 | + |
| 13 | +## Usage Instructions |
| 14 | + |
| 15 | +Integrate CrowdStrike Identity Protection into workflows to search sensors, fetch documented sensor details by device ID, and run documented sensor aggregate queries. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Tools |
| 20 | + |
| 21 | +### `crowdstrike_get_sensor_aggregates` |
| 22 | + |
| 23 | +Get documented CrowdStrike Identity Protection sensor aggregates from a JSON aggregate query body |
| 24 | + |
| 25 | +#### Input |
| 26 | + |
| 27 | +| Parameter | Type | Required | Description | |
| 28 | +| --------- | ---- | -------- | ----------- | |
| 29 | +| `clientId` | string | Yes | CrowdStrike Falcon API client ID | |
| 30 | +| `clientSecret` | string | Yes | CrowdStrike Falcon API client secret | |
| 31 | +| `cloud` | string | Yes | CrowdStrike Falcon cloud region | |
| 32 | +| `aggregateQuery` | json | Yes | JSON aggregate query body documented by CrowdStrike for sensor aggregates | |
| 33 | + |
| 34 | +#### Output |
| 35 | + |
| 36 | +| Parameter | Type | Description | |
| 37 | +| --------- | ---- | ----------- | |
| 38 | +| `aggregates` | array | Aggregate result groups returned by CrowdStrike | |
| 39 | +| ↳ `buckets` | array | Buckets within the aggregate result | |
| 40 | +| ↳ `count` | number | Bucket document count | |
| 41 | +| ↳ `from` | number | Bucket lower bound | |
| 42 | +| ↳ `keyAsString` | string | String representation of the bucket key | |
| 43 | +| ↳ `label` | json | Bucket label object | |
| 44 | +| ↳ `stringFrom` | string | String lower bound | |
| 45 | +| ↳ `stringTo` | string | String upper bound | |
| 46 | +| ↳ `subAggregates` | json | Nested aggregate results for this bucket | |
| 47 | +| ↳ `to` | number | Bucket upper bound | |
| 48 | +| ↳ `value` | number | Bucket metric value | |
| 49 | +| ↳ `valueAsString` | string | String representation of the bucket value | |
| 50 | +| ↳ `docCountErrorUpperBound` | number | Upper bound for bucket count error | |
| 51 | +| ↳ `name` | string | Aggregate result name | |
| 52 | +| ↳ `sumOtherDocCount` | number | Document count not included in the returned buckets | |
| 53 | +| `count` | number | Number of aggregate result groups returned | |
| 54 | + |
| 55 | +### `crowdstrike_get_sensor_details` |
| 56 | + |
| 57 | +Get documented CrowdStrike Identity Protection sensor details for one or more device IDs |
| 58 | + |
| 59 | +#### Input |
| 60 | + |
| 61 | +| Parameter | Type | Required | Description | |
| 62 | +| --------- | ---- | -------- | ----------- | |
| 63 | +| `clientId` | string | Yes | CrowdStrike Falcon API client ID | |
| 64 | +| `clientSecret` | string | Yes | CrowdStrike Falcon API client secret | |
| 65 | +| `cloud` | string | Yes | CrowdStrike Falcon cloud region | |
| 66 | +| `ids` | json | Yes | JSON array of CrowdStrike sensor device IDs | |
| 67 | + |
| 68 | +#### Output |
| 69 | + |
| 70 | +| Parameter | Type | Description | |
| 71 | +| --------- | ---- | ----------- | |
| 72 | +| `sensors` | array | CrowdStrike identity sensor detail records | |
| 73 | +| ↳ `agentVersion` | string | Sensor agent version | |
| 74 | +| ↳ `cid` | string | CrowdStrike customer identifier | |
| 75 | +| ↳ `deviceId` | string | Sensor device identifier | |
| 76 | +| ↳ `heartbeatTime` | number | Last heartbeat timestamp | |
| 77 | +| ↳ `hostname` | string | Sensor hostname | |
| 78 | +| ↳ `idpPolicyId` | string | Assigned Identity Protection policy ID | |
| 79 | +| ↳ `idpPolicyName` | string | Assigned Identity Protection policy name | |
| 80 | +| ↳ `ipAddress` | string | Sensor local IP address | |
| 81 | +| ↳ `kerberosConfig` | string | Kerberos configuration status | |
| 82 | +| ↳ `ldapConfig` | string | LDAP configuration status | |
| 83 | +| ↳ `ldapsConfig` | string | LDAPS configuration status | |
| 84 | +| ↳ `machineDomain` | string | Machine domain | |
| 85 | +| ↳ `ntlmConfig` | string | NTLM configuration status | |
| 86 | +| ↳ `osVersion` | string | Operating system version | |
| 87 | +| ↳ `rdpToDcConfig` | string | RDP to domain controller configuration status | |
| 88 | +| ↳ `smbToDcConfig` | string | SMB to domain controller configuration status | |
| 89 | +| ↳ `status` | string | Sensor protection status | |
| 90 | +| ↳ `statusCauses` | array | Documented causes behind the current status | |
| 91 | +| ↳ `tiEnabled` | string | Threat intelligence enablement status | |
| 92 | +| `count` | number | Number of sensors returned | |
| 93 | +| `pagination` | json | Pagination metadata when returned by the underlying API | |
| 94 | +| ↳ `limit` | number | Page size used for the query | |
| 95 | +| ↳ `offset` | number | Offset returned by CrowdStrike | |
| 96 | +| ↳ `total` | number | Total records available | |
| 97 | + |
| 98 | +### `crowdstrike_query_sensors` |
| 99 | + |
| 100 | +Search CrowdStrike identity protection sensors by hostname, IP, or related fields |
| 101 | + |
| 102 | +#### Input |
| 103 | + |
| 104 | +| Parameter | Type | Required | Description | |
| 105 | +| --------- | ---- | -------- | ----------- | |
| 106 | +| `clientId` | string | Yes | CrowdStrike Falcon API client ID | |
| 107 | +| `clientSecret` | string | Yes | CrowdStrike Falcon API client secret | |
| 108 | +| `cloud` | string | Yes | CrowdStrike Falcon cloud region | |
| 109 | +| `filter` | string | No | Falcon Query Language filter for identity sensor search | |
| 110 | +| `limit` | number | No | Maximum number of sensor records to return | |
| 111 | +| `offset` | number | No | Pagination offset for the identity sensor query | |
| 112 | +| `sort` | string | No | Sort expression for identity sensor results | |
| 113 | + |
| 114 | +#### Output |
| 115 | + |
| 116 | +| Parameter | Type | Description | |
| 117 | +| --------- | ---- | ----------- | |
| 118 | +| `sensors` | array | Matching CrowdStrike identity sensor records | |
| 119 | +| ↳ `agentVersion` | string | Sensor agent version | |
| 120 | +| ↳ `cid` | string | CrowdStrike customer identifier | |
| 121 | +| ↳ `deviceId` | string | Sensor device identifier | |
| 122 | +| ↳ `heartbeatTime` | number | Last heartbeat timestamp | |
| 123 | +| ↳ `hostname` | string | Sensor hostname | |
| 124 | +| ↳ `idpPolicyId` | string | Assigned Identity Protection policy ID | |
| 125 | +| ↳ `idpPolicyName` | string | Assigned Identity Protection policy name | |
| 126 | +| ↳ `ipAddress` | string | Sensor local IP address | |
| 127 | +| ↳ `kerberosConfig` | string | Kerberos configuration status | |
| 128 | +| ↳ `ldapConfig` | string | LDAP configuration status | |
| 129 | +| ↳ `ldapsConfig` | string | LDAPS configuration status | |
| 130 | +| ↳ `machineDomain` | string | Machine domain | |
| 131 | +| ↳ `ntlmConfig` | string | NTLM configuration status | |
| 132 | +| ↳ `osVersion` | string | Operating system version | |
| 133 | +| ↳ `rdpToDcConfig` | string | RDP to domain controller configuration status | |
| 134 | +| ↳ `smbToDcConfig` | string | SMB to domain controller configuration status | |
| 135 | +| ↳ `status` | string | Sensor protection status | |
| 136 | +| ↳ `statusCauses` | array | Documented causes behind the current status | |
| 137 | +| ↳ `tiEnabled` | string | Threat intelligence enablement status | |
| 138 | +| `count` | number | Number of sensors returned | |
| 139 | +| `pagination` | json | Pagination metadata \(limit, offset, total\) | |
| 140 | +| ↳ `limit` | number | Page size used for the query | |
| 141 | +| ↳ `offset` | number | Offset returned by CrowdStrike | |
| 142 | +| ↳ `total` | number | Total records available | |
| 143 | + |
| 144 | + |
0 commit comments