Skip to content

Get FalconRole

bk-cs edited this page Sep 22, 2022 · 24 revisions

Get-FalconRole

SYNOPSIS

Search for user roles and assignments

DESCRIPTION

Requires 'User Management: Read'.

PARAMETERS

Name Type Min Max Pattern Allowed Pipeline PipelineByName Description
Id String[] True True Role identifier
UserId 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}$ False False User identifier
Cid String ^[a-fA-F0-9]{32}$ False False Customer identifier
Filter String False False
Sort String `cid asc<BR>cid desc<BR>role_name asc<BR>role_name
Limit Int32 1 500 False False
Offset String False False
DirectOnly Boolean False False
Detailed Switch False False Retrieve detailed information

SYNTAX

Get-FalconRole [[-Cid] <String>] [-Detailed] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconRole [-Id] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconRole [-UserId] <String> [[-Cid] <String>] [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [[-Offset] <String>] [[-DirectOnly] <Boolean>] -WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconRole [-Detailed] [-WhatIf] [-Confirm] [<CommonParameters>]

Generated 20220922 using PSFalcon v2.2.3

Clone this wiki locally