Skip to content

Get FalconUser

bk-cs edited this page Sep 22, 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[] True True User identifier
Filter String False False 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
False False Property and direction to sort results
Limit Int32 1 500 False False Maximum number of results per request
Offset Int32 False False Position to begin retrieving results
Username String[] False False Username
Detailed Switch False False Retrieve detailed information
Include String[] roles False False 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>]

Generated 20220922 using PSFalcon v2.2.3

Clone this wiki locally