Skip to main content

User management

User management is console users and two seeded roles (falcon-administrator, falcon-analyst). Paths are under /user-management/…. Deprecated /users/… and /user-roles/… are not implemented.

This collection is not CrowdStrike production. It does not call Falcon cloud.

RPC field notes: IdentityService. REST schemas: API reference. Filter syntax: FQL.

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_console from CreateSession (POST /identity/entities/sessions/v1)
  • Authorization: Bearer with user-management:read for query, get, and roles
  • user-management:write for create, patch, delete, and role actions

A session cookie bypasses OAuth scopes (console admin). Seed client cs-local-read / cs-local-secret has user-management:read only.

HTTP paths​

MethodPathUse
GET/user-management/queries/users/v1Query ids. Query: filter, limit, offset, sort (email.asc / email.desc, also uid, first_name, last_name). Empty filter returns all ids.
POST/user-management/entities/users/GET/v1Get users. Body { "ids": [] }.
POST/user-management/entities/users/v1Create. Body email, first_name, last_name, password (≥8), role_id. Empty required fields or duplicate email → 400. Success 201.
PATCH/user-management/entities/users/v1Update. Body uuid plus first_name, last_name, and/or role_id.
DELETE/user-management/entities/users/v1?ids=Delete. Cannot delete the last Falcon Administrator → 400.
GET/user-management/queries/roles/v1Role ids (falcon-administrator, falcon-analyst).
POST/user-management/entities/user-role-actions/v1Body action (grant or revoke), user_uuid, role_id.

Allowed FQL properties on users: email, uid, first_name, last_name. Unknown property or invalid filter → 400.

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
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/user-management/queries/users/v1?filter=email:%27analyst*%27'

resources includes user-local-analyst. Invalid FQL 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/user-management/queries/users/v1?filter=not-fql'

Query users (Bearer)​

TOKEN='<access_token from POST /oauth2/token with cs-local-read>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/user-management/queries/users/v1'

user-management:read → 200. A token with only hosts:read → 403. Missing or revoked token → 401.

Create and get​

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"email":"[email protected]","first_name":"Ada","last_name":"Second","password":"Password1","role_id":"falcon-analyst"}' \
http://127.0.0.1:8088/user-management/entities/users/v1

curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
-H 'Content-Type: application/json' \
-d '{"ids":["user-local-analyst"]}' \
http://127.0.0.1:8088/user-management/entities/users/GET/v1

Create requires user-management:write (or a session). The new user can call CreateSession with that email and password.

Last administrator​

Deleting the only Falcon Administrator (the seed user while they are the only admin) is 400:

curl -sS -X DELETE -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/user-management/entities/users/v1?ids=user-local-analyst'

OAuth2 mint/revoke: OAuth2.