Get FalconUser
Search for users
Requires 'User Management: Read'.
| Name | Type | Min | Max | Pattern | Allowed | Pipeline | PipelineByName | Description |
|---|---|---|---|---|---|---|---|---|
| Id | String[] | ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ |
User identifier | |||||
| Username | String[] | False | False | Username | ||||
| Filter | String | False | False | Falcon Query Language expression to limit results | ||||
| Sort | String | `first_name | asc<BR>first_name |
desc<BR>last_name |
asc<BR>last_name |
|||
| Limit | Int32 | 1 |
500 |
False | False | Maximum number of results per request | ||
| Offset | Int32 | False | False | Position to begin retrieving results | ||||
| Detailed | Switch | False | False | Retrieve detailed information | ||||
| Include | String[] | roles |
False | False | Include additional properties |
Get-FalconUser [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [[-Offset] <Int32>] [-Detailed] [-Include <String[]>] [-WhatIf] [-Confirm] <CommonParameters>]
Get-FalconUser [-Id] <String[]> [-Include <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconUser -Username <String[]> [-Include <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Generated 20220922 using PSFalcon v2.2.3
