Skip to content

Get FalconUser

bk-cs edited this page Oct 10, 2022 · 25 revisions

Get-FalconUser

SYNOPSIS

Search for users

DESCRIPTION

Requires 'User Management: Read'.

PARAMETERS

Name Type Min Max Allowed Pipeline PipelineByName Description
Id String[] X X User identifier
Filter String Falcon Query Language expression to limit results
Sort String first_name|asc
first_name|desc
last_name|asc
last_name|desc
name|asc
name|desc
uid|asc
uid|desc
Property and direction to sort results
Limit Int32 1 500 Maximum number of results per request
Offset Int32 Position to begin retrieving results
Username String[] Username
Detailed Switch Retrieve detailed information
Include String[] roles Include additional properties

SYNTAX

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[]> [-Detailed] [-Include <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

USAGE

2022-10-10: PSFalcon v2.2.3

Clone this wiki locally