Contents x
    Groups
    • 06 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Groups

    • Updated on 06 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get-LiquitGroup

    Synopsis

    This command displays a list of groups defined in the Liquit Workspace.

    Syntax

     Get-LiquitGroup 
    [[-Source] <IdentitySource>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

 Get-LiquitGroup 
    [-ID] <string[]> 
    [[-Source] <IdentitySource>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

 Get-LiquitGroup 
    [-IdentityRef] <IdentityRef[]> 
    [[-Source] <IdentitySource>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

 Get-LiquitGroup 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

 Get-LiquitGroup  
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

    Examples

    Example 1: Get-LiquitGroup

     Get-LiquitGroup

    This command lists all available groups within Liquit Workspace.

    Example 2: Get-LiquitGroup

     Get-LiquitGroup -id 00000000-0000-0000-0000-000000000000

    This command selects the group with the id 00000000-0000-0000-0000-000000000000.

    Parameters

    NameValueDescriptionRequiredDefault value
    Source<IdentitySource>The source of the group.
    Search<string>This parameter serves a similar purpose to the search box found in the groups table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Identity. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes.
    Name<string>Searches on the group name itself.
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault
    Was this article helpful?
    What's Next