Get FalconUser

Get-FalconUser

SYNOPSIS

Search for users

DESCRIPTION

Requires 'User management: Read'.

PARAMETERS

Name	Type	Description	Min	Max	Allowed	Pipeline	PipelineByName
Id	String[]	User identifier				X	X
Filter	String	Falcon Query Language expression to limit results assigned_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

SYNTAX

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>]

REFERENCE

Endpoints

GET /user-management/queries/users/v1
POST /user-management/entities/users/GET/v1

falconpy

queryUserV1
retrieveUsersGETV1

USAGE

List all user IDs

Get-FalconUser

Find a user ID by username

Get-FalconUser -Username jane.doe@example.com

List all users and their details

Get-FalconUser -Detailed

NOTE: The Include parameter can be used to append user roles to Get-FalconUser output.

Get details on one or more users

Get-FalconUser -Id <id>, <id>

2023-11-27: PSFalcon v2.2.6