-
Notifications
You must be signed in to change notification settings - Fork 67
Get FalconUser
bk-cs edited this page Nov 30, 2023
·
25 revisions
Search for users
Requires 'User management: Read'.
Name | Type | Description | Min | Max | Allowed | Pipeline | PipelineByName |
---|---|---|---|---|---|---|---|
Id | String[] | User identifier | X | X | |||
Filter | String |
Falcon Query Language expression to limit resultsassigned_cids cid first_name last_name name uid
|
|||||
Sort | String | Property and direction to sort results |
first_name|asc first_name|desc last_name|asc last_name|desc name|asc name|desc uid|asc uid|desc
|
||||
Limit | Int32 | Maximum number of results per request | 1 |
500 |
|||
Offset | Int32 | Position to begin retrieving results | |||||
Username | String[] | Username | |||||
Include | String[] | Include additional properties | roles |
||||
Detailed | Switch | Retrieve detailed information | |||||
All | Switch | Repeat requests until all available results are retrieved | |||||
Total | Switch | Display total result count instead of results |
Get-FalconUser [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Include <String[]>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconUser [-Id] <String[]> [-Include <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconUser -Username <String[]> [-Include <String[]>] [-Detailed] [-WhatIf] [-Confirm] [<CommonParameters>]
GET /user-management/queries/users/v1
POST /user-management/entities/users/GET/v1
Get-FalconUser
Get-FalconUser -Username jane.doe@example.com
Get-FalconUser -Detailed
NOTE: The Include
parameter can be used to append user roles to Get-FalconUser
output.
Get-FalconUser -Id <id>, <id>
2023-11-27: PSFalcon v2.2.6
- Using PSFalcon
-
Commands and Permissions
- Configuration Import/Export
- Container Security
- Detection and Prevention Policies
- Discover for Cloud and Containers
- Discover
- Event Streams
- Falcon Complete Dashboards
- Falcon Complete Message Center
- Falcon Data Replicator
- Falcon Intelligence
- Falcon Intelligence Recon
- Falcon OverWatch Dashboards
- Falcon Sandbox
- FileVantage
- Firewall Management
- Flight Control
- Horizon
- Host and Host Group Management
- Identity Protection
- Image Assessment
- Incident and Detection Monitoring
- Installation Tokens
- Kubernetes Protection
- MalQuery
- Mobile Host Enrollment
- On-Demand Scanning
- Quarantine
- Real-time Response
- Real-time Response Policy
- Scheduled Reports and Searches
- Sensor Download
- Sensor Update Policy
- Spotlight
- Tailored Intelligence
- Third-party ingestion
- USB Device Control Policy
- Users and Roles
- Zero Trust Assessment
- Examples
-
CrowdStrike SDKs
- PSFalcon - PowerShell
- FalconPy - Python 3
- goFalcon - Go
- Rusty Falcon - Rust