StoreFront

Federated Authentication Service Configuration

October 18, 2024

Contributed by:

N C C

When using authentication methods such as SAML, where the user does not enter their credentials directly into Citrix Workspace app, by default it is not possible to single sign-on into VDAs. In these cases, you can use Federated Authentication Service (FAS) to provide single sign-on to VDAs using certificate authentication.

To use FAS with StoreFront, you must configure StoreFront using the PowerShell SDK. Use Set-STFStoreLaunchOptions to set the VDA logon data logon provider to FASLogonDataProvider.

By default, StoreFront selects the FAS server at launch. You can change this so that StoreFront selects the FAS server at login. This has the advantage that it avoid delays that can occur at launch, particularly if a FAS server is unavailable so it has to try multiple FAS servers. However it has the disadvantage that if the FAS server becomes unavailable between login and launch then the launch either fails or falls back to username and password authentication (see FAS server unavailability). To configure the behavior, run PowerShell cmdlet Set-STFClaimsFactoryNames with parameter ClaimsFactoryName. To choose the FAS server at login, set it to FASClaimsFactory. To restore the default behavior and choose a FAS server at launch, set it to standardClaimsFactory.

For example to enable FAS for a store and select the server at login:

$store = Get-STFStoreService -VirtualPath [VirtualPath]
$auth = Get-STFAuthenticationService -StoreService $store
Set-STFStoreLaunchOptions -StoreService $store -VdaLogonDataProvider "FASLogonDataProvider"
Set-STFClaimsFactoryNames -AuthenticationService $auth -ClaimsFactoryName "FASClaimsFactory"
<!--NeedCopy-->

To disable FAS for a store:

$store = Get-STFStoreService -VirtualPath [VirtualPath]
$auth = Get-STFAuthenticationService -StoreService $store
Set-STFStoreLaunchOptions -StoreService $store -VdaLogonDataProvider ""
Set-STFClaimsFactoryNames -AuthenticationService $auth -ClaimsFactoryName "standardClaimsFactory"
<!--NeedCopy-->

Substitute [VirtualPath] for the appropriate virtual path, e.g. /Citrix/Store.

To configure the list of FAS servers and other settings you must use Group policy. For more details see FAS documentation.

FAS server unavailability

If the FAS server is unavailable the launch fails by default. However, you can configure StoreFront such that if the FAS server is unavailable, users can sign on to the VDA by entering their credentials. To change the configuration use Powershell cmdlet Set-STFStoreLaunchOptions with parameter FederatedAuthenticationServiceFailover. For example to enable fail over for a store:

$storeService = Get-STFStoreService -VirtualPath [VirtualPath]
Set-STFStoreLaunchOptions $storeService -FederatedAuthenticationServiceFailover $True
<!--NeedCopy-->

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

Federated Authentication Service Configuration

October 18, 2024

Contributed by:

N C C

October 18, 2024

Contributed by:

N C C

Federated Authentication Service Configuration

FAS server unavailability

In this article