Set-STFEntraIdSettings
Sets Entra ID related settings.
Syntax
Set-STFEntraIdSettings -AuthenticationService <AuthenticationService> [-TenantId <String>] [-CitrixIdentityCustomer <String>] [-GraphApiTimeoutSeconds <Int32>] [-TotalGraphApiTimeoutSeconds <Int32>] [-GraphApiUrl <String>] [-AuthorityUrl <String>] [-AlwaysForceLogon <Boolean>] -Enabled <Boolean> [<CommonParameters>]
Detailed Description
Sets Entra ID related settings.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| AuthenticationService | The authentication service to update | true | true (ByValue) | |
| TenantId | The Tenant ID for Entra ID | false | true (ByValue) | |
| CitrixIdentityCustomer | The Citrix Identity Customer | false | true (ByValue) | |
| GraphApiTimeoutSeconds | The Graph API timeout in seconds | false | true (ByValue) | |
| TotalGraphApiTimeoutSeconds | The total Graph API timeout in seconds | false | true (ByValue) | |
| GraphApiUrl | The Graph API URL | false | true (ByValue) | |
| AuthorityUrl | The Authority URL | false | true (ByValue) | |
| AlwaysForceLogon | Always force logon | false | true (ByValue) | |
| Enabled | Enabled EntraID | true | true (ByValue) |
Input Type
Citrix.StoreFront.Model.Authentication.AuthenticationService
Parameter AuthenticationService: A .NET class representing the configuration of a StoreFront Authentication service
System.String
Parameter TenantId: The .NET
System.String reference type
System.String
Parameter CitrixIdentityCustomer: The .NET
System.String reference type
System.Int32
Parameter GraphApiTimeoutSeconds: The .NET
System.Int32 value type
System.Int32
Parameter TotalGraphApiTimeoutSeconds: The .NET
System.Int32 value type
System.String
Parameter GraphApiUrl: The .NET
System.String reference type
System.String
Parameter AuthorityUrl: The .NET
System.String reference type
System.Boolean
Parameter AlwaysForceLogon: The .NET
System.Boolean value type
System.Boolean
Parameter Enabled: The .NET
System.Boolean value type
Return Values
None
Examples
EXAMPLE 1 Basic usage
$authenticationService = Get-STFAuthenticationService
Set-STFEntraIdSettings -AuthenticationService $authenticationService -TenantId "example-tenant-id" -Enabled $true
REMARKS
This example sets the TenantId for Entra ID Settings for the specified authentication service
EXAMPLE 2 With EntraIdSsoEnabled
$store = Get-STFStoreService
$auth = Get-STFAuthService -StoreService $store
Set-STFEntraIdSettings -AuthenticationService $auth
Set-StoreLaunchOptions -Store $store -EntraIdSsoEnabled $true