New-BrokerUserToken
Returns a signed user token
Syntax
New-BrokerUserToken
-SessionKey <Guid>
-Sid <String>
-VdaIPAddress <String>
-BrokeringTime <DateTime>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Creates a signed token for the specified combination of user and VDA.
Examples
EXAMPLE 1
Returns signed user token
New-BrokerUserToken -SessionKey "f47ac10b-58cc-4372-a567-0e02b2c3d479" -Sid "S-1-5-21-992878714-4041223874-2616370337-1001" -VdaIPAddress "10.0.0.1" -BrokeringTime '04/24/2024 18:00:00'
Parameters
-SessionKey
The session key.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sid
The users SID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VdaIPAddress
The IP address of the VDA.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BrokeringTime
The time at which the session is brokered.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
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
A signed user token