Get FalconUserGroup

Get-FalconUserGroup

SYNOPSIS

Search for Falcon Flight Control user groups

DESCRIPTION

Requires 'Flight Control: Read'.

PARAMETERS

Name	Type	Description	Min	Max	Allowed	Pipeline	PipelineByName
Id	String[]	User group identifier				X	X
Name	String	User group name
Sort	String	Property and direction to sort results			last_modified_timestamp.asc last_modified_timestamp.desc name.asc name.desc
Limit	Int32	Maximum number of results per request	1	5000
Offset	Int32	Position to begin retrieving results
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-FalconUserGroup [[-Name] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconUserGroup -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

REFERENCE

Endpoints

GET /mssp/entities/user-groups/v2
GET /mssp/queries/user-groups/v1

falconpy

queryUserGroups
getUserGroupsByIDV2

USAGE

List user groups by ID

Get-FalconUserGroup [-Detailed] [-All]

Retrieve detail about one or more user groups

Get-FalconUserGroup -Id <id>, <id>

2023-04-25: PSFalcon v2.2.5