Storefront Powershell SDK 2411

Set-STFWebReceiverAuthenticationMethods

November 28, 2024

Contributed by:

Set the WebReceiver authentication methods

Syntax

Set-STFWebReceiverAuthenticationMethods [-WebReceiverService] <WebReceiverService> [[-AuthenticationMethods] <String[]>] [[-TokenLifeTime] <TimeSpan>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Sets the list of allowed authentication methods for a given Web Receiver site. The accepted authentication method names are:

“ExplicitForms” - explicit authentication with user credentials

“IntegratedWindows” - domain pass - through authentication

“Certificate” - smart card authentication

“CitrixAGBasic” - NetScaler Gateway single sign - on

This cmdlet is typically used to restrict the authentication methods enabled for a Web Receiver

site to a subset of those enabled for its associated Authentication service.

Note, a Web Receiver authentication method is only effective when enabled for both the Web Receiver

site and its associated Authentication service.

Parameters

Name	Description	Required?	Pipeline Input
WebReceiverService	The WebReceiver service.	true	true (ByValue)
AuthenticationMethods	Authentication methods to support	false	false
TokenLifeTime	The lifetime of the authentication token before it expiries.	false	false

Input Type

Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService

Parameter WebReceiverService: A .NET class representing the configuration of a StoreFront Web Receiver service

System.String[]

Parameter AuthenticationMethods: The .NET System.String reference type

System.TimeSpan

Parameter TokenLifeTime: The .NET System.TimeSpan value type

Return Values

None

Examples

EXAMPLE 1 Set authentication methods

$webReceiver = Get-STFWebReceiverService "/Citrix/StoreWeb"
Set-STFWebReceiverAuthenticationMethods -WebReceiverService $webReceiver -AuthenticationMethods Get-STFWebReceiverAuthenticationMethodsAvailable
<!--NeedCopy-->

REMARKS

Set the current WebReceiver authentication methods for /Citrix/StoreWeb to be all those available.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-STFWebReceiverAuthenticationMethods

November 28, 2024

Contributed by:

November 28, 2024

Contributed by:

Set-STFWebReceiverAuthenticationMethods

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService

System.String[]

System.TimeSpan

Return Values

None

Examples

EXAMPLE 1 Set authentication methods

In this article