Users

Updated on 07 Nov 2024
2 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get-LiquitUser

Synopsis

This command displays a list of all the users from an identity source. Alternatively, you can use this command to select a specific user.

Syntax

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

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

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

Get-LiquitUser 
    [-Search] <string> 
    [[-Source]  <IdentitySource>] 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Get-LiquitUser 
    [-Name] <string> 
    [[-Source] <IdentitySource>] 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Examples

Example 1: Get-LiquitUser

 $identitySource = Get-LiquitIdentitySource -ID 00000000-0000-0000-0000-000000000000
 Get-LiquitUser -Source $identitySource

This command lists all the available users in the specified identity source.

Example 2: Get-LiquitUser

 Get-LiquitUser

This command lists all the available users in Liquit Workspace.

Example 3: Get-LiquitUser

 Get-LiquitUser  -ID 00000000-0000-0000-0000-000000000000

This command selects one defined user.

Parameters

Name	Value	Description	Required	Default value
Search	`<string>`	This parameter serves a similar purpose to the search box found in the users table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Display name and Username. 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 user name itself.
Source	`<IdentitySource>`	The identity source assigned to the user.
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

New-LiquitUser

Synopsis

This command creates a new user in the local identity source.

Syntax

New-LiquitUser 
    [-Source] <IdentitySource> 
    [-Name] <string> 
    [-SecurePassword] <securestring>
    [-DisplayName <string>] 
    [-Mail <string>]
    [-LiquitContext <LiquitContext>]
    [-WhatIf]
    [-Confirm]  
    [<CommonParameters>]

New-LiquitUser 
    [-Source] <IdentitySource> 
    [-Name] <string> 
    [-Password] <string> 
    [-DisplayName <string>] 
    [-Mail <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Example

 $source = Get-LiquitIdentitySource -ID 00000000-0000-0000-0000-000000000000
 $securePass = Read-Host "Please provide your desired password" -AsSecureString
 New-LiquitUser -Source $source -Name "PowerShell User" -Displayname "PowerShell Management User" -SecurePassword $securePass

This command creates a new user named "PowerShell User"; it has the display name of "PowerShell Management User" and uses the password provided at the prompt.

Parameters

Name	Value	Description	Required	Default value
Source	`<IdentitySource>`	The identity source of the user (only LOCAL is allowed).	Yes
Username	`<string>`	The user name of the user to be created.	Yes
Password	`<string>`	The password that goes with the new user.	Yes*
SecurePassword	`<SecureString>`	The secure password that goes with the new user.	Yes*
Displayname	`<string>`	A friendly name for the user.	No
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

* Required

The command expects one of the required fields to be set.

Was this article helpful?

What's Next

User Collections

Table of contents

Get-LiquitUser
New-LiquitUser