CSPM IOA users
CSPM IOA users is the CSPM Registration collection for this CID —
GetIoaUsers (SOURCE GetIOAUsers, PEP 8 get_ioa_users).
The path is GET /ioa/entities/users/v1. Image assessment policies / remaining cloud and other cloud/container collections are not
implemented (not yet). This is not GetIoaEvents (/ioa/entities/events/v1),
not GetBehaviorDetections Cloud IOA
(/detects/entities/ioa/v1), not Custom IOA (/ioarules/…),
not GetCspmScanSchedule (/settings/scan-schedule/v1), and not
GetCSPMPolicy / GetCSPMPoliciesDetails / GetCSPMPolicySettings
(/settings/entities/policy-details/…, /settings/entities/policy/v1).
Cloud IOA events is a separate collection:
CSPM IOA events. Cloud IOA is a separate
collection: CSPM IOA. Custom IOA is a separate
collection: Custom IOA. Cloud scan schedule is a
separate collection:
CSPM scan schedule. CSPM policies is a
separate collection: CSPM policies. This is
not the HelloService template sample (GET /api/hello).
This collection is not CrowdStrike production. It does not call Falcon cloud. It is not CrowdStrike Falcon Cloud or Horizon.
RPC field notes:
CspmRegistrationService.
REST schemas: API reference. GetIoaUsers uses query params,
not FQL. Filter this slice is optional cloud_provider and optional
state. Extra unused query keys including parameters are ignored.
Clone success is JSON MSA 200 CspmIoaUser. Fields are
user_id, policy_id, cloud_provider, account_id, state. There
is no cid on the wire.
These curls use Host: crowdstrike-api.localhost against Compose
Traefik on :8088. If the hostname already resolves to Traefik, you can
omit the Host header and call http://crowdstrike-api.localhost instead.
Auth
Every call needs a console session or a Bearer token:
- Cookie
cs_consolefromCreateSession(POST /identity/entities/sessions/v1) Authorization: Bearerwithcspm-registration:read
A session cookie bypasses OAuth scopes. Seed client cs-local-hosts
(hosts:read only) cannot list IOA users (403).
GetIoaUsers stays cspm-registration:read (not write).
Unit tests use a client named cs-local-cspm with
cspm-registration:read; that client can list IOA users
(200). It is not in the production seed. There is no seeded
production client with cspm-registration:read — use the console
cookie, or a client you created with that scope. Missing or revoked
token → 401.
HTTP paths
| Method | Path | Use |
|---|---|---|
GET | /ioa/entities/users/v1 | List CSPM IOA users. RPC GetIoaUsers (SOURCE GetIOAUsers). PEP 8 get_ioa_users. Query: optional cloud_provider, optional state. Success 200 MSA CspmIoaUser. Extra unused query keys ignored. Distinct from GetIoaEvents /ioa/entities/events/v1, GetBehaviorDetections Cloud IOA /detects/entities/ioa/v1, Custom IOA /ioarules/…, GetCspmScanSchedule /settings/scan-schedule/v1, and CSPM policies /settings/entities/policy-details/… /settings/entities/policy/v1. |
Empty filters return every user in this CID ordered by user_id
ASC. If cloud_provider is set and is not exactly aws, azure, or
gcp → 400 unknown cloud_provider. If state is set and is not
exactly open or closed → 400 unknown state. Extra unused
query keys including parameters are ignored.
JSON is user_id, policy_id, cloud_provider, account_id,
state.
This is not GetIoaEvents, GetBehaviorDetections Cloud IOA, Custom
IOA, Cloud scan schedule, Cloud policies, or the HelloService template.
Image assessment policies / remaining cloud and other cloud
collections are not implemented (not yet). Cloud IOA events uses
/ioa/entities/events/v1: CSPM IOA events. Cloud
IOA uses /detects/entities/ioa/…: CSPM IOA. Custom IOA
uses /ioarules/…: Custom IOA. Cloud scan schedule
uses /settings/scan-schedule/v1:
CSPM scan schedule. CSPM policies uses
/settings/entities/policy-details/… and
/settings/entities/policy/v1: CSPM policies.
Seed users
user_id | policy_id | cloud_provider | account_id | state |
|---|---|---|---|---|
ioa-user-lab-1 | 101 | aws | 111122223333 | open |
ioa-user-lab-2 | 102 | azure | sub-lab-1 | closed |
Empty filters return both (order user_id ASC: ioa-user-lab-1,
then ioa-user-lab-2). cloud_provider=aws returns
ioa-user-lab-1. state=closed returns ioa-user-lab-2.
Session cookie
curl -sS -c cookies.txt -H 'Host: crowdstrike-api.localhost' \
-H 'Content-Type: application/json' \
-d '{"email":"[email protected]","password":"FalconLocal!1","cloud":"us-1"}' \
http://127.0.0.1:8088/identity/entities/sessions/v1
List IOA users (cookie)
Empty filters return at least the two seed users, including
ioa-user-lab-1 and ioa-user-lab-2:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1'
cloud_provider=aws returns ioa-user-lab-1:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1?cloud_provider=aws'
state=closed returns ioa-user-lab-2:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1?state=closed'
Invalid cloud_provider is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1?cloud_provider=foo'
Invalid state is 400:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1?state=foo'
Extra unused query keys including parameters are ignored:
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioa/entities/users/v1?parameters=ignored'
cs-local-hosts (hosts:read only) is 403:
TOKEN='<access_token from cs-local-hosts>'
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/ioa/entities/users/v1'
No cookie and no Bearer is 401:
curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' \
'http://127.0.0.1:8088/ioa/entities/users/v1'
Image assessment policies / remaining cloud
and other cloud collections are not implemented (not yet). Cloud IOA
events is a separate collection:
CSPM IOA events. Cloud IOA is a separate
collection: CSPM IOA. Custom IOA is a separate
collection: Custom IOA. Cloud scan schedule is a
separate collection:
CSPM scan schedule. CSPM policies is a
separate collection: CSPM policies. This is
not the HelloService template (GET /api/hello).
List (Bearer)
TOKEN='<access_token from a client with cspm-registration:read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/ioa/entities/users/v1'
cspm-registration:read → 200 (including unit-test client
cs-local-cspm). A token without that scope (including hosts:read
only, e.g. cs-local-hosts) → 403. Missing or revoked token →
401. GetIoaUsers stays cspm-registration:read. PEP 8
get_ioa_users. There is no seeded production client with
cspm-registration:read — use the console cookie, or a client you
created with that scope.
OAuth2 mint/revoke: OAuth2. Accessible scopes: API clients.