This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-XDAuthentication
Configures the SDK to communicate with either an on-premises or cloud-hosted controller, with the required address and authentication settings.
Syntax
Get-XDAuthentication
[-CustomerId <String>]
[-BearerToken <String>]
[-ProfileName <String>]
[-ServiceProfileName <String>]
[-EnvironmentName <String>]
[-Staging]
[-ProxyUsername <String>]
[-ProxyPassword <SecureString>]
[-ProxyUseDefault]
[<CommonParameters>]
<!--NeedCopy-->
Description
Configures user authentication settings for the SDK cmdlets in the active session. The SDK can be configured to work in on-premises mode, where the AdminAddress specified for any cmdlet is honored, and one of three Cloud authentication modes, where the AdminAddress is automatically overridden, and the required XD authentication is obtained and added to each message.
The three Cloud authentication modes are:
- CloudMC: Prompt for MyCitrix credentials for each PowerShell session.
- CloudApi: Use the customer ID and Citrix Cloud API Key stored in the user’s Windows profile.
- CloudToken: Use the specified customer ID and current Citrix Cloud Bearer Token.
These modes each use a Bearer Token to generate a Citrix Cloud auth header (stored in the session variable $XDAuthToken), which is added to each subsequent cmdlet call to the cloud-hosted controller. The Bearer Token is automatically refreshed within the current session for up to 12 hours.
The Customer Id is used to generate the AdminAddress, which is stored in the session variable $XDSDKProxy, and will override any AdminAddress parameter passed to subsequent cmdlets.
Specifying -BearerToken will put the SDK into CloudToken mode, ignoring a default authorization profile.
Specifying -ProfileName will attempt to load the named authentication profile from the users’ profile store, and set the authentication mode based on the profile’s settings.
If the session variable ‘$XDStoredCredentials’ has been previously set by Set-XDCredentials, those will be used before checking the profile store for a default profile.
If neither -BearerToken, nor -ProfileName are specified, a profile named ‘default’ will be loaded and used if found.
If none of previous methods result in a usable Citrix Cloud Bearer Token, or the SDK is explicitly configured for CloudMC mode, the user will be presented with a GUI logon dialog to authenticate using MyCitrix credentials. If the logon is associated with multiple Citrix Cloud customers, the user will have option to select which one to administer, unless it has been pre-selected by passing the CustomerId parameter.
Examples
EXAMPLE 1
Authenticate using the default XD authentication method for the current session.
Get-XDAuthentication
<!--NeedCopy-->
EXAMPLE 2
Authenticate with Citrix Cloud using the specified Bearer Token.
Get-XDAuthentication -BearerToken JesDFasldfasdfjas;jfhlkagkgf...
<!--NeedCopy-->
EXAMPLE 3
Authenticate with Citrix Cloud using the API Key stored in the specified profile.
Get-XDAuthentication -ProfileName TestApiKey
<!--NeedCopy-->
Parameters
-CustomerId
Citrix Cloud Customer name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BearerToken
A Citrix Cloud-generated Bearer Token for the specified customer. A valid Bearer Token supplied to this command will be automatically refreshed in the current session for the next 12 hours.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProfileName
The name associated with a set of credentials in the local store that are to be read.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceProfileName
Service Profile Name used for Service Key Authentication - Internal use only
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-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 |
-ProxyUsername
Username to login to proxy
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ProxyPassword
Password to login to proxy
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyUseDefault
Use default proxy credentials to authenticate proxy
| 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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.