Contents x
    User Collection Members
    • 24 Jun 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    User Collection Members

    • Updated on 24 Jun 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get-LiquitUserCollectionMembers

    Synopsis

    This command displays a list of users that are members of a specific user collection.

    Syntax

    Get-LiquitUserCollectionMembers 
    [-UserCollection] <UserCollection[]> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>]

    Example

    $UserCollection = Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000 
Get-LiquitUserCollectionMembers -UserCollection $UserCollection

    This command lists all available users from the selected user collection.

    Add-LiquitUserCollectionMember

    Synopsis

    This command adds a user to a collection.

    Syntax

    Add-LiquitUserCollectionMember 
    [-UserCollection] <UserCollection> 
    [-User] <User[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]

    Example

    $User = Get-LiquitUser -id 00000000-0000-0000-0000-000000000000 
$UserCollection = Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000
Add-LiquitUserCollectionMember -UserCollection $UserCollection -User $User

    This command adds a specific user to a specific collection.

    Parameters

    NameValueDescriptionRequiredDefault value
    UserCollection<UserCollection>The collection to which you add the user.Yes
    User<User[]>The user to add to the collection.Yes
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault

    Remove-LiquitUserCollectionMember

    Synopsis

    This command removes a user from a collection.

    Syntax

    Remove-LiquitUserCollectionMember 
    [-UserCollection] <UserCollection> 
    [-User] <User[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]

    Example

    $User = Get-LiquitUser -id 00000000-0000-0000-0000-000000000000 
$UserCollection = Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000 
Remove-LiquitUserCollectionMember -UserCollection $UserCollection -User $User

    This command removes the selected user from the selected collection.

    Parameters

    NameValueDescriptionRequiredDefault value
    UserCollection<UserCollection>The collection from which you remove the user.Yes
    User<User[]>The user to remove from the collection.Yes
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault
    Was this article helpful?
    What's Next