Authenticator

Get-LiquitAuthenticator

Synopsis

This command displays a list of all authenticators known within the Application Workspace or selects an authenticator in particular.

Syntax

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

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

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

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

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

Example

$Authenticator = Get-LiquitAuthenticator

This command displays all authenticators known within the Application Workspace.

Parameters

Name	Value	Description	Required	Default value
Search	`<string>`	This parameter serves a similar purpose to the search box found in the authenticators 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 authenticator name itself.
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

New-LiquitAuthenticator

Synopsis

This command creates a new authenticator.

Syntax

New-LiquitAuthenticator
    [-Name] <string>  
    [-Identifier] <string>  
    [-Enabled <bool>]  
    [-Description <string>]  
    [-Type {radius}]  
    [-AuthType {Challange | Challenge | OTP}]  
    [-Servers <AuthenticatorRadiusServer[]>]  
    [-LiquitContext <LiquitContext>]
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Name	Value	Description	Required	Default value
Type	`{radius}`	Currently, only RADIUS is supported.
AuthType	`{Challange \| Challenge \| OTP}`	Select here if the RADIUS server requires a challenge or OTP authentication. The challenge type will start the authentication with the username and password and expects a challenge back from the RADIUS server for a token code. OTP will directly provide the username and token code and expects an authentication result.
Servers	`<AuthenticatorRadiusServer[]>`	Add the servers that provide the multi-factor authentication. For the parameters of this objects, see New-LiquitAuthenticatorRadiusServer.
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Set-LiquitAuthenticator

Synopsis

This command edits the properties of an authenticator.

Set-LiquitAuthenticator
    [-Authenticator] <Authenticator[]>  
    [-Name <string>]  
    [-Enabled <bool>]  
    [-Identifier <string>]  
    [-AuthType {Challange | Challenge | OTP}]  
    [-Description <string>]  
    [-Servers <AuthenticatorRadiusServer[]>]  
    [-LiquitContext <LiquitContext>]
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Remove-LiquitAuthenticator

Synopsis

This command removes an authenticator from the Application Workspace.

Syntax

Remove-LiquitAuthenticator 
[-Authenticator] <Authenticator[]>  
[-LiquitContext <LiquitContext>]
[-WhatIf] 
[-Confirm]
[<CommonParameters>]

New-LiquitAuthenticatorRadiusServer

Synopsis

This item needs to be assigned to an authenticator as an AuthenticatorRadiusServer array. Note that it is not saved automatically on the local device, it is available only in your current PowerShell session.

Syntax

New-LiquitAuthenticatorRadiusServer
[-Name] <string>  
[-Address] <string>  
[-SharedSecret] <string>  
[-Encryption] {PAP}  
[-Port <uint16>]  
[-Priority <int>]  
[-Retry <int>]  
[-Timeout <int>]  
[-LiquitContext <LiquitContext>]
[-WhatIf] 
[-Confirm]
[<CommonParameters>]

Name	Value	Description	Required	Default value
Name	`<string>`	The name of the Radius server.	Yes
Address	`<string>`	The host name or the IP address of the RADIUS server.	Yes
SharedSecret	`<string>`	The character string configured on the client hardware and on the RADIUS server.	Yes
Encryption	`{PAP}`	The encryption type the server uses. Currently only 'PAP' is supported.	Yes
Port	`<uint16>`	The port number on which the RADIUS server can be accessed.	No	812
Priority	`<int>`	The priority of the server; the lower the number the higher the priority.	No	0
Retry	`<int>`	The number of attempts to connect the RADIUS server after a timeout occurs.	No	1
Timeout	`<int>`	The number of seconds a server will wait for a response from the RADIUS server.	No	5 (seconds)
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default