Citrix StoreFront SDK PowerShell Modules

Get-STFAuthenticationService

July 29, 2024

Contributed by:

Get a StoreFront Authentication service.

Syntax

Get-STFAuthenticationService [[-VirtualPath] <String>] [[-SiteId] <Int64>] [<CommonParameters>]

Get-STFAuthenticationService [-StoreService] <StoreService> [[-VirtualPath] <String>] [[-SiteId] <Int64>] [<CommonParameters>]

Get-STFAuthenticationService [-WebReceiverService] <WebReceiverService> [[-VirtualPath] <String>] [[-SiteId] <Int64>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Gets an Authentication service that matches the supplied criteria. An Authentication service can be retrieved by supplying a linked StoreFront service or service details.

Parameters

Name	Description	Required?	Pipeline Input
VirtualPath	Virtual path to the Authentication service website. Excluding the parameter will match on any virtual path	false	false
SiteId	IIS site id of the web site in which the Autentication service is hosted	false	false
StoreService	The Store used by the Authentication service	true	true (ByValue)
WebReceiverService	The Web Receiver used by the Authentication service	true	false

Input Type

System.String

Parameter VirtualPath: The .NET System.String reference type

System.Int64

Parameter SiteId: The .NET System.Int64 value type

Citrix.StoreFront.Model.Store.StoreService

Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service

Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService

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

Return Values

AuthenticationService

A .NET class representing the configuration of a StoreFront Authentication service

Examples

EXAMPLE 1 Get all Authentication services

Get-STFAuthenticationService
<!--NeedCopy-->

REMARKS

Get all configured Authentication services.

OUTPUT

ProducerService         : Authentication Token Producer
ServiceTokenCertificate : BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1
TokenValidationService  : Default Token Validation Service
TokenIssuerUrl          : http://example.storefront.com/Citrix/StoreAuth/auth/v1/token
AuthenticationOptions   : Logging Level:None, Hide Errors:False, Collect Evidence to send to FAS:False
Authentication          : TokenServiceId:707a864e-90d2-408a-9111-404e1e705d10, Protocol Choices:7
AuthenticationProtocols : {[citrixAGBasicAuthentication,
                          Citrix.StoreFront.Model.Authentication.NetscalerAuthentication], [formsProtocol,
                          Citrix.StoreFront.Model.Authentication.FormsProtocol], [explicitBL,
                          Citrix.StoreFront.Model.Authentication.ExplicitAuthentication],
                          [delegatedDirectoryClaimFactory,
                          Citrix.StoreFront.Model.Authentication.DelegatedDirectorySettings]}
PnaAuthentication       : Citrix.StoreFront.Model.Authentication.PnaAuthentication
SiteId                  : 1
VirtualPath             : /Citrix/StoreAuth
FriendlyName            : StoreAuth
Hmacs                   : {}
Certificates            : {BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1, A02C8391926A23C3547D8D34EB654240FE9BC3FA,
                          333131FF3C2F74E4F786BD3CCBB6967FDFA30795}
TokenManagers           : {Authentication Token Producer, Default Token Validation Service}
Routing                 : StoreAuth:http://example.storefront.com/
ServiceRef              : 1__Citrix_StoreAuth
ConfigurationFile       : C:\inetpub\wwwroot\Citrix\StoreAuth\web.config
TenantId                : 860e9401-39c8-4f2c-928d-34251
<!--NeedCopy-->

EXAMPLE 2 Get an authentication service

Get-STFAuthenticationService -VirtualPath /Citrix/StoreAuth
<!--NeedCopy-->

REMARKS

Get an Authentication service configured at a specific virtual path.

OUTPUT

ProducerService         : Authentication Token Producer
ServiceTokenCertificate : BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1
TokenValidationService  : Default Token Validation Service
TokenIssuerUrl          : http://example.storefront.com/Citrix/StoreAuth/auth/v1/token
AuthenticationOptions   : Logging Level:None, Hide Errors:False, Collect Evidence to send to FAS:False
Authentication          : TokenServiceId:707a864e-90d2-408a-9111-404e1e705d10, Protocol Choices:7
AuthenticationProtocols : {[citrixAGBasicAuthentication,
                          Citrix.StoreFront.Model.Authentication.NetscalerAuthentication], [formsProtocol,
                          Citrix.StoreFront.Model.Authentication.FormsProtocol], [explicitBL,
                          Citrix.StoreFront.Model.Authentication.ExplicitAuthentication],
                          [delegatedDirectoryClaimFactory,
                          Citrix.StoreFront.Model.Authentication.DelegatedDirectorySettings]}
PnaAuthentication       : Citrix.StoreFront.Model.Authentication.PnaAuthentication
SiteId                  : 1
VirtualPath             : /Citrix/StoreAuth
FriendlyName            : StoreAuth
Hmacs                   : {}
Certificates            : {BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1, A02C8391926A23C3547D8D34EB654240FE9BC3FA,
                          333131FF3C2F74E4F786BD3CCBB6967FDFA30795}
TokenManagers           : {Authentication Token Producer, Default Token Validation Service}
Routing                 : StoreAuth:http://example.storefront.com/
ServiceRef              : 1__Citrix_StoreAuth
ConfigurationFile       : C:\inetpub\wwwroot\Citrix\StoreAuth\web.config
TenantId                : 860e9401-39c8-4f2c-928d-34251
<!--NeedCopy-->

EXAMPLE 3 Get a Stores Authentication service

$store = Get-STFStoreService
Get-STFAuthenticationService -StoreService $storeService
<!--NeedCopy-->

REMARKS

Get the Authentication service responsible for authenticating a store.

OUTPUT

ProducerService         : Authentication Token Producer
ServiceTokenCertificate : BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1
TokenValidationService  : Default Token Validation Service
TokenIssuerUrl          : http://example.storefront.com/Citrix/StoreAuth/auth/v1/token
AuthenticationOptions   : Logging Level:None, Hide Errors:False, Collect Evidence to send to FAS:False
Authentication          : TokenServiceId:707a864e-90d2-408a-9111-404e1e705d10, Protocol Choices:7
AuthenticationProtocols : {[citrixAGBasicAuthentication,
                          Citrix.StoreFront.Model.Authentication.NetscalerAuthentication], [formsProtocol,
                          Citrix.StoreFront.Model.Authentication.FormsProtocol], [explicitBL,
                          Citrix.StoreFront.Model.Authentication.ExplicitAuthentication],
                          [delegatedDirectoryClaimFactory,
                          Citrix.StoreFront.Model.Authentication.DelegatedDirectorySettings]}
PnaAuthentication       : Citrix.StoreFront.Model.Authentication.PnaAuthentication
SiteId                  : 1
VirtualPath             : /Citrix/StoreAuth
FriendlyName            : StoreAuth
Hmacs                   : {}
Certificates            : {BD1A9D3C2948EC8EFAA153EFEEDB23351F8B80D1, A02C8391926A23C3547D8D34EB654240FE9BC3FA,
                          333131FF3C2F74E4F786BD3CCBB6967FDFA30795}
TokenManagers           : {Authentication Token Producer, Default Token Validation Service}
Routing                 : StoreAuth:http://example.storefront.com/
ServiceRef              : 1__Citrix_StoreAuth
ConfigurationFile       : C:\inetpub\wwwroot\Citrix\StoreAuth\web.config
TenantId                : 860e9401-39c8-4f2c-928d-34251102b840
<!--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

Get-STFAuthenticationService

July 29, 2024

Contributed by:

July 29, 2024

Contributed by:

Get-STFAuthenticationService

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

System.Int64

Citrix.StoreFront.Model.Store.StoreService

Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService

Return Values

AuthenticationService

Examples

EXAMPLE 1 Get all Authentication services

EXAMPLE 2 Get an authentication service

EXAMPLE 3 Get a Stores Authentication service

In this article