Credentials

Prev Next

Get-LiquitCredential

Synopsis

This command displays a list of all credentials available within the Credential Store or you can select a specific credential.

Syntax

 Get-LiquitCredential 
   [-LiquitContext <LiquitContext>]  
   [<CommonParameters>]

 Get-LiquitCredential 
   [-ID] <guid[]> 
   [-LiquitContext <LiquitContext>]  
   [<CommonParameters>]

 Get-LiquitCredential 
   [-EntityRef] <EntityRef[]> 
   [-LiquitContext <LiquitContext>] 
   [<CommonParameters>]

 Get-LiquitCredential 
   [-Type] {Static | Template} 
   [-LiquitContext <LiquitContext>]  
   [<CommonParameters>]
   
 Get-LiquitCredential 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

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

Examples

Example 1: Get-LiquitCredential

 Get-LiquitCredential

This command displays all the credentials known within Application Workspace.

Example 2: Get-LiquitCredential

 Get-LiquitCredential -type Template

This command selects all credentials of the Template type.

Example 3: Get-LiquitCredential

 Get-LiquitCredential -id 00000000-0000-0000-0000-000000000000

This command selects the credential with ID 00000000-0000-0000-0000-000000000000.

Parameters

Name Value Description Required Default value
Search <string> This parameter serves a similar purpose to the search box found in the credential store table from the Application Workspace UI. It enables users to search multiple columns within the table, such as Name and Type. 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 credential name itself.
LiquitContext <LiquitContext> Determines the selected zone. No Default

New-LiquitCredential

Synopsis

This command creates a new credential.

Syntax

 New-LiquitCredential 
   [-Name] <string>
   -UserName <string> 
   -Password <string> 
   [-Static] 
   [-Description <string>] 
   [-LiquitContext <LiquitContext>] 
   [-WhatIf] 
   [-Confirm]  
   [<CommonParameters>]

   New-LiquitCredential 
   [-Name] <string> 
   -Template 
   -UserName <string> 
   [-Description <string>] 
   [-Verify <bool>] 
   [-LiquitContext <LiquitContext>] 
   [-WhatIf] 
   [-Confirm]  
   [<CommonParameters>]

Examples

Example 1: New-LiquitCredential

    New-LiquitCredential -Name "PowerShell Static Credential" -Static -UserName "username" -Password "password" -Description "New Credential"

This command creates a new static type credential with the name "PowerShell Static Credential".

Example 2: New-LiquitCredential

    New-LiquitCredential -Name "PowerShell Template Credential" -Template -UserName "username" -Description "New Credential" -Verify $true

This command creates a new template type credential with the name "PowerShell Template Credential".

Parameters

Name Value Description Required Default value
Name <string> Provide a name for the credential. Yes
Static Determines whether or not the credential will be static. If template isn’t specified
Template Determines whether or not the credential will be a template. If static isn’t specified
UserName <string> A username used for authentication. In the case of a Template credential, you can use variables in the username. Yes
Password <string> The password used for authentication. Static only
Verify <bool> Application Workspace checks with the identity source if your credentials are valid. Does not work if MFA is enabled.
Description <string> Provide a description for the credential. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Set-LiquitCredential

Synopsis

This command edits the properties of a credential.

Syntax

 Set-LiquitCredential 
   [-Credential] <Credential[]> 
   [-Name <string>] 
   [-Description <string>] 
   [-UserName <string>] 
   [-Password <string>]
   [-Verify <bool>] 
   [-LiquitContext <LiquitContext>] 
   [-WhatIf] 
   [-Confirm]  
   [<CommonParameters>]

Example

    $credential = Get-LiquitCredential -id 00000000-0000-0000-0000-000000000000
    Set-LiquitCredential -Credential $credential -Name "Updated PowerShell Credential"

This command updates an existing credential and renames it "Updated PowerShell Credential".

Parameters

Name Value Description Required Default value
Name <string> Provide a name for the credential. Yes
UserName <string> A username used for authentication. In the case of a Template credential, you can use variables in the username. Yes
Password <string> The password used for authentication. Static only
Verify <bool> Application Workspace checks with the identity source if your credentials are valid. Does not work if MFA is enabled.
Description <string> Provide a description for the credential. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitCredential

Synopsis

This command removes a credential from the Application Workspace.

Syntax

 Remove-LiquitCredential 
   [-Credential] <Credential[]> 
   [-LiquitContext <LiquitContext>] 
   [-WhatIf] 
   [-Confirm]  
   [<CommonParameters>]

Example

     $credential = Get- LiquitCredential -id 00000000-0000-0000-0000-000000000000
     Remove-LiquitCredential -Credential $credential

This command removes the selected credential from Application Workspace.

Parameters

Name Value Description Required Default value
Credential <Credential[]> The credential you wish to remove. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default