Citrix Daas SDK

Set-XDCredentials

May 28, 2025

Contributed by:

Saves XD credentials to persistent store (-StoreAs) or temporarily for the shell using shell variable $XDStoredCredentials.

Syntax

Set-XDCredentials
   [-ProfileName <String>]
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Set-XDCredentials
   [-ProfileType <SDKProfileType>]
   [-StoreAs <String>]
   [-Default]
   [-CustomerId <String>]
   -APIKey <String>
   -SecretKey <String>
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Set-XDCredentials
   [-ProfileType <SDKProfileType>]
   [-StoreAs <String>]
   [-Default]
   [-CustomerId <String>]
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Set-XDCredentials
   [-ProfileType <SDKProfileType>]
   [-StoreAs <String>]
   [-Default]
   [-CustomerId <String>]
   -SecureClientFile <String>
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Set-XDCredentials
   [-ProfileType <SDKProfileType>]
   [-StoreAs <String>]
   [-Default]
   -CustomerId <String>
   [-InstanceId <String>]
   -ServiceKey <String>
   -ServiceName <String>
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Set-XDCredentials
   [-ProfileType <SDKProfileType>]
   [-StoreAs <String>]
   [-Default]
   [-CustomerId <String>]
   -ServicePrincipalFile <String>
   [-EnvironmentName <String>]
   [-Staging]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Saves credentials to persistent store (-StoreAs) or temporarily for the current shell using variable $XDStoredCredentials.

Examples

EXAMPLE 1

Loads the credentials contained in the specified profile and sets them active for all cmdlets in the current shell.

Set-XDCredentials -ProfileName myCredentials
<!--NeedCopy-->

EXAMPLE 2

Stores a default CloudApi credentials profile for customer acme, with the specified Citrix Cloud Service Principal ID and Secret.

Set-XDCredentials -StoreAs default -ProfileType CloudApi -CustomerId acme -APIKey xxxxxxxx -SecretKey yyyyyyyyy
<!--NeedCopy-->

EXAMPLE 3

Sets temporary CloudApi credentials for customer testcust in the current shell.

Set-XDCredentials -ProfileType CloudApi -CustomerId testcust -ServicePrincipalFile C:\Temp\serviceprincipal.csv.
<!--NeedCopy-->

Parameters

-APIKey

The Citrix Cloud Service Principal ID or Secure Client ID.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SecretKey

The Citrix Cloud Service Principal Secret or Secure Client Secret.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipalFile

The Citrix Cloud Service Principal File containing an ID and Secret.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SecureClientFile

The Citrix Cloud Secure Client File containing an ID and Secret.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceKey

The Citrix Cloud service key.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceName

The Citrix Cloud service name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProfileName

The user-defined name of a credentials profile containing credential information. If the specified profile is found in the secure credential store, it will be loaded and used as the default for the duration of the session in shell variable $XDStoredCredentials.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProfileType

OnPrem: Kerberos (for communicating with on-premises Controllers).
CloudMC: Prompt for MyCitrix credentials for each PowerShell session.
CloudApi: A customer ID and API Key stored in the user’s Windows profile.
CloudToken: A customer ID and current Citrix Cloud bearer token, which is not persisted across PowerShell sessions.

Type:	SDKProfileType
Accepted values:	OnPrem, CloudMC, CloudApi, CloudToken, CloudServiceKey
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StoreAs

The name to be used to identify the profile in the secure credential store. Use this with the -ProfileName parameter on cmdlets to load the stored credentials.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Default

Sets the profile as the default profile across powershell sessions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomerId

Citrix Cloud Customer name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceId

The Citrix Cloud Instance Id associated with the service key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnvironmentName

Commercial, Japan or USGovernment

Type:	String
Accepted values:	Commercial, Japan, USGovernment
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Staging

Internal use only

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe input into this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

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-XDCredentials

May 28, 2025

Contributed by:

May 28, 2025

Contributed by:

Set-XDCredentials

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

Parameters

-APIKey

-SecretKey

-ServicePrincipalFile

-SecureClientFile

-ServiceKey

-ServiceName

-ProfileName

-ProfileType

-StoreAs

-Default

-CustomerId

-InstanceId

-EnvironmentName

-Staging

CommonParameters

Inputs

None

Outputs

None

Related Links

In this article